1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2017 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''.
25 @dircategory Software development
27 * Binutils: (binutils). The GNU binary utilities.
30 @dircategory Individual utilities
32 * addr2line: (binutils)addr2line. Convert addresses to file and line.
33 * ar: (binutils)ar. Create, modify, and extract from archives.
34 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
35 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
36 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
37 * nlmconv: (binutils)nlmconv. Converts object code into an NLM.
38 * nm: (binutils)nm. List symbols from object files.
39 * objcopy: (binutils)objcopy. Copy and translate object files.
40 * objdump: (binutils)objdump. Display information from object files.
41 * ranlib: (binutils)ranlib. Generate index to archive contents.
42 * readelf: (binutils)readelf. Display the contents of ELF format files.
43 * size: (binutils)size. List section sizes and total size.
44 * strings: (binutils)strings. List printable strings from files.
45 * strip: (binutils)strip. Discard symbols.
46 * elfedit: (binutils)elfedit. Update the ELF header of ELF files.
47 * windmc: (binutils)windmc. Generator for Windows message resources.
48 * windres: (binutils)windres. Manipulate Windows resources.
52 @title The @sc{gnu} Binary Utilities
53 @ifset VERSION_PACKAGE
54 @subtitle @value{VERSION_PACKAGE}
56 @subtitle Version @value{VERSION}
58 @subtitle @value{UPDATED}
59 @author Roland H. Pesch
60 @author Jeffrey M. Osier
61 @author Cygnus Support
65 {\parskip=0pt \hfill Cygnus Support\par \hfill
66 Texinfo \texinfoversion\par }
69 @vskip 0pt plus 1filll
78 This brief manual contains documentation for the @sc{gnu} binary
80 @ifset VERSION_PACKAGE
81 @value{VERSION_PACKAGE}
83 version @value{VERSION}:
88 Create, modify, and extract from archives
91 List symbols from object files
94 Copy and translate object files
97 Display information from object files
100 Generate index to archive contents
103 Display the contents of ELF format files.
106 List file section sizes and total size
109 List printable strings from files
115 Update the ELF header of ELF files.
118 Demangle encoded C++ symbols (on MS-DOS, this program is named
122 Convert addresses into file names and line numbers
125 Convert object code into a Netware Loadable Module
128 Manipulate Windows resources
131 Generator for Windows message resources
134 Create the files needed to build and use Dynamic Link Libraries
138 This document is distributed under the terms of the GNU Free
139 Documentation License version 1.3. A copy of the license is included
140 in the section entitled ``GNU Free Documentation License''.
143 * ar:: Create, modify, and extract from archives
144 * nm:: List symbols from object files
145 * objcopy:: Copy and translate object files
146 * objdump:: Display information from object files
147 * ranlib:: Generate index to archive contents
148 * size:: List section sizes and total size
149 * strings:: List printable strings from files
150 * strip:: Discard symbols
151 * c++filt:: Filter to demangle encoded C++ symbols
152 * cxxfilt: c++filt. MS-DOS name for c++filt
153 * addr2line:: Convert addresses to file and line
154 * nlmconv:: Converts object code into an NLM
155 * windmc:: Generator for Windows message resources
156 * windres:: Manipulate Windows resources
157 * dlltool:: Create files needed to build and use DLLs
158 * readelf:: Display the contents of ELF format files
159 * elfedit:: Update the ELF header of ELF files
160 * Common Options:: Command-line options for all utilities
161 * Selecting the Target System:: How these utilities determine the target
162 * Reporting Bugs:: Reporting Bugs
163 * GNU Free Documentation License:: GNU Free Documentation License
164 * Binutils Index:: Binutils Index
172 @cindex collections of files
174 @c man title ar create, modify, and extract from archives
177 ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
178 ar -M [ <mri-script ]
181 @c man begin DESCRIPTION ar
183 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
184 archives. An @dfn{archive} is a single file holding a collection of
185 other files in a structure that makes it possible to retrieve
186 the original individual files (called @dfn{members} of the archive).
188 The original files' contents, mode (permissions), timestamp, owner, and
189 group are preserved in the archive, and can be restored on
193 @sc{gnu} @command{ar} can maintain archives whose members have names of any
194 length; however, depending on how @command{ar} is configured on your
195 system, a limit on member-name length may be imposed for compatibility
196 with archive formats maintained with other tools. If it exists, the
197 limit is often 15 characters (typical of formats related to a.out) or 16
198 characters (typical of formats related to coff).
201 @command{ar} is considered a binary utility because archives of this sort
202 are most often used as @dfn{libraries} holding commonly needed
206 @command{ar} creates an index to the symbols defined in relocatable
207 object modules in the archive when you specify the modifier @samp{s}.
208 Once created, this index is updated in the archive whenever @command{ar}
209 makes a change to its contents (save for the @samp{q} update operation).
210 An archive with such an index speeds up linking to the library, and
211 allows routines in the library to call each other without regard to
212 their placement in the archive.
214 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
215 table. If an archive lacks the table, another form of @command{ar} called
216 @command{ranlib} can be used to add just the table.
218 @cindex thin archives
219 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
220 which contains a symbol index and references to the original copies
221 of the member files of the archive. This is useful for building
222 libraries for use within a local build tree, where the relocatable
223 objects are expected to remain available, and copying the contents of
224 each object would only waste time and space.
226 An archive can either be @emph{thin} or it can be normal. It cannot
227 be both at the same time. Once an archive is created its format
228 cannot be changed without first deleting it and then creating a new
229 archive in its place.
231 Thin archives are also @emph{flattened}, so that adding one thin
232 archive to another thin archive does not nest it, as would happen with
233 a normal archive. Instead the elements of the first archive are added
234 individually to the second archive.
236 The paths to the elements of the archive are stored relative to the
239 @cindex compatibility, @command{ar}
240 @cindex @command{ar} compatibility
241 @sc{gnu} @command{ar} is designed to be compatible with two different
242 facilities. You can control its activity using command-line options,
243 like the different varieties of @command{ar} on Unix systems; or, if you
244 specify the single command-line option @option{-M}, you can control it
245 with a script supplied via standard input, like the MRI ``librarian''
251 * ar cmdline:: Controlling @command{ar} on the command line
252 * ar scripts:: Controlling @command{ar} with a script
257 @section Controlling @command{ar} on the Command Line
260 @c man begin SYNOPSIS ar
261 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
265 @cindex Unix compatibility, @command{ar}
266 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
267 arguments to execute: one keyletter specifying the @emph{operation}
268 (optionally accompanied by other keyletters specifying
269 @emph{modifiers}), and the archive name to act on.
271 Most operations can also accept further @var{member} arguments,
272 specifying particular files to operate on.
274 @c man begin OPTIONS ar
276 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
277 flags @var{mod} in any order, within the first command-line argument.
279 If you wish, you may begin the first command-line argument with a
282 @cindex operations on archive
283 The @var{p} keyletter specifies what operation to execute; it may be
284 any of the following, but you must specify only one of them:
288 @cindex deleting from archive
289 @emph{Delete} modules from the archive. Specify the names of modules to
290 be deleted as @var{member}@dots{}; the archive is untouched if you
291 specify no files to delete.
293 If you specify the @samp{v} modifier, @command{ar} lists each module
297 @cindex moving in archive
298 Use this operation to @emph{move} members in an archive.
300 The ordering of members in an archive can make a difference in how
301 programs are linked using the library, if a symbol is defined in more
304 If no modifiers are used with @code{m}, any members you name in the
305 @var{member} arguments are moved to the @emph{end} of the archive;
306 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
307 specified place instead.
310 @cindex printing from archive
311 @emph{Print} the specified members of the archive, to the standard
312 output file. If the @samp{v} modifier is specified, show the member
313 name before copying its contents to standard output.
315 If you specify no @var{member} arguments, all the files in the archive are
319 @cindex quick append to archive
320 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
321 @var{archive}, without checking for replacement.
323 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
324 operation; new members are always placed at the end of the archive.
326 The modifier @samp{v} makes @command{ar} list each file as it is appended.
328 Since the point of this operation is speed, implementations of
329 @command{ar} have the option of not updating the archive's symbol
330 table if one exists. Too many different systems however assume that
331 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
332 rebuild the table even with a quick append.
334 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
335 synonym for @samp{r} - replacing already existing files in the
336 archive and appending new ones at the end.
339 @cindex replacement in archive
340 Insert the files @var{member}@dots{} into @var{archive} (with
341 @emph{replacement}). This operation differs from @samp{q} in that any
342 previously existing members are deleted if their names match those being
345 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
346 displays an error message, and leaves undisturbed any existing members
347 of the archive matching that name.
349 By default, new members are added at the end of the file; but you may
350 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
351 placement relative to some existing member.
353 The modifier @samp{v} used with this operation elicits a line of
354 output for each file inserted, along with one of the letters @samp{a} or
355 @samp{r} to indicate whether the file was appended (no old member
356 deleted) or replaced.
360 Add an index to the archive, or update it if it already exists. Note
361 this command is an exception to the rule that there can only be one
362 command letter, as it is possible to use it as either a command or a
363 modifier. In either case it does the same thing.
366 @cindex contents of archive
367 Display a @emph{table} listing the contents of @var{archive}, or those
368 of the files listed in @var{member}@dots{} that are present in the
369 archive. Normally only the member name is shown; if you also want to
370 see the modes (permissions), timestamp, owner, group, and size, you can
371 request that by also specifying the @samp{v} modifier.
373 If you do not specify a @var{member}, all files in the archive
376 @cindex repeated names in archive
377 @cindex name duplication in archive
378 If there is more than one file with the same name (say, @samp{fie}) in
379 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
380 first instance; to see them all, you must ask for a complete
381 listing---in our example, @samp{ar t b.a}.
382 @c WRS only; per Gumby, this is implementation-dependent, and in a more
383 @c recent case in fact works the other way.
386 @cindex extract from archive
387 @emph{Extract} members (named @var{member}) from the archive. You can
388 use the @samp{v} modifier with this operation, to request that
389 @command{ar} list each name as it extracts it.
391 If you do not specify a @var{member}, all files in the archive
394 Files cannot be extracted from a thin archive.
397 A number of modifiers (@var{mod}) may immediately follow the @var{p}
398 keyletter, to specify variations on an operation's behavior:
402 @cindex relative placement in archive
403 Add new files @emph{after} an existing member of the
404 archive. If you use the modifier @samp{a}, the name of an existing archive
405 member must be present as the @var{relpos} argument, before the
406 @var{archive} specification.
409 Add new files @emph{before} an existing member of the
410 archive. If you use the modifier @samp{b}, the name of an existing archive
411 member must be present as the @var{relpos} argument, before the
412 @var{archive} specification. (same as @samp{i}).
415 @cindex creating archives
416 @emph{Create} the archive. The specified @var{archive} is always
417 created if it did not exist, when you request an update. But a warning is
418 issued unless you specify in advance that you expect to create it, by
422 @cindex deterministic archives
423 @kindex --enable-deterministic-archives
424 Operate in @emph{deterministic} mode. When adding files and the archive
425 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
426 for all files. When this option is used, if @command{ar} is used with
427 identical options and identical input files, multiple runs will create
428 identical output files regardless of the input files' owners, groups,
429 file modes, or modification times.
431 If @file{binutils} was configured with
432 @option{--enable-deterministic-archives}, then this mode is on by default.
433 It can be disabled with the @samp{U} modifier, below.
436 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
437 names of any length. This will cause it to create archives which are
438 not compatible with the native @command{ar} program on some systems. If
439 this is a concern, the @samp{f} modifier may be used to truncate file
440 names when putting them in the archive.
443 Insert new files @emph{before} an existing member of the
444 archive. If you use the modifier @samp{i}, the name of an existing archive
445 member must be present as the @var{relpos} argument, before the
446 @var{archive} specification. (same as @samp{b}).
449 This modifier is accepted but not used.
450 @c whaffor ar l modifier??? presumably compat; with
451 @c what???---doc@@cygnus.com, 25jan91
454 Uses the @var{count} parameter. This is used if there are multiple
455 entries in the archive with the same name. Extract or delete instance
456 @var{count} of the given name from the archive.
459 @cindex dates in archive
460 Preserve the @emph{original} dates of members when extracting them. If
461 you do not specify this modifier, files extracted from the archive
462 are stamped with the time of extraction.
465 Use the full path name when matching names in the archive. @sc{gnu}
466 @command{ar} can not create an archive with a full path name (such archives
467 are not POSIX complaint), but other archive creators can. This option
468 will cause @sc{gnu} @command{ar} to match file names using a complete path
469 name, which can be convenient when extracting a single file from an
470 archive created by another tool.
473 @cindex writing archive index
474 Write an object-file index into the archive, or update an existing one,
475 even if no other change is made to the archive. You may use this modifier
476 flag either with any operation, or alone. Running @samp{ar s} on an
477 archive is equivalent to running @samp{ranlib} on it.
480 @cindex not writing archive index
481 Do not generate an archive symbol table. This can speed up building a
482 large library in several steps. The resulting archive can not be used
483 with the linker. In order to build a symbol table, you must omit the
484 @samp{S} modifier on the last execution of @samp{ar}, or you must run
485 @samp{ranlib} on the archive.
488 @cindex creating thin archive
489 Make the specified @var{archive} a @emph{thin} archive. If it already
490 exists and is a regular archive, the existing members must be present
491 in the same directory as @var{archive}.
494 @cindex updating an archive
495 Normally, @samp{ar r}@dots{} inserts all files
496 listed into the archive. If you would like to insert @emph{only} those
497 of the files you list that are newer than existing members of the same
498 names, use this modifier. The @samp{u} modifier is allowed only for the
499 operation @samp{r} (replace). In particular, the combination @samp{qu} is
500 not allowed, since checking the timestamps would lose any speed
501 advantage from the operation @samp{q}.
504 @cindex deterministic archives
505 @kindex --enable-deterministic-archives
506 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
507 of the @samp{D} modifier, above: added files and the archive index will
508 get their actual UID, GID, timestamp, and file mode values.
510 This is the default unless @file{binutils} was configured with
511 @option{--enable-deterministic-archives}.
514 This modifier requests the @emph{verbose} version of an operation. Many
515 operations display additional information, such as filenames processed,
516 when the modifier @samp{v} is appended.
519 This modifier shows the version number of @command{ar}.
522 The @command{ar} program also supports some command line options which
523 are neither modifiers nor actions, but which do change its behaviour
528 Displays the list of command line options supported by @command{ar}
532 Displays the version information of @command{ar} and then exits.
535 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
536 compatibility with AIX. The behaviour produced by this option is the
537 default for @sc{gnu} @command{ar}. @command{ar} does not support any
538 of the other @samp{-X} options; in particular, it does not support
539 @option{-X32} which is the default for AIX @command{ar}.
541 @item --plugin @var{name}
543 The optional command line switch @option{--plugin @var{name}} causes
544 @command{ar} to load the plugin called @var{name} which adds support
545 for more file formats, including object files with link-time
546 optimization information.
548 This option is only available if the toolchain has been built with
549 plugin support enabled.
551 If @option{--plugin} is not provided, but plugin support has been
552 enabled then @command{ar} iterates over the files in
553 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
554 plugin that claims the object in question is used.
556 Please note that this plugin search directory is @emph{not} the one
557 used by @command{ld}'s @option{-plugin} option. In order to make
558 @command{ar} use the linker plugin it must be copied into the
559 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
560 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
561 based compilations it is called @file{LLVMgold.so}. The GCC plugin
562 is always backwards compatible with earlier versions, so it is
563 sufficient to just copy the newest one.
565 @item --target @var{target}
566 The optional command line switch @option{--target @var{bfdname}}
567 specifies that the archive members are in an object code format
568 different from your system's default format. See
569 @xref{Target Selection}, for more information.
574 @c man begin SEEALSO ar
575 nm(1), ranlib(1), and the Info entries for @file{binutils}.
580 @section Controlling @command{ar} with a Script
583 ar -M [ <@var{script} ]
586 @cindex MRI compatibility, @command{ar}
587 @cindex scripts, @command{ar}
588 If you use the single command-line option @samp{-M} with @command{ar}, you
589 can control its operation with a rudimentary command language. This
590 form of @command{ar} operates interactively if standard input is coming
591 directly from a terminal. During interactive use, @command{ar} prompts for
592 input (the prompt is @samp{AR >}), and continues executing even after
593 errors. If you redirect standard input to a script file, no prompts are
594 issued, and @command{ar} abandons execution (with a nonzero exit code)
597 The @command{ar} command language is @emph{not} designed to be equivalent
598 to the command-line options; in fact, it provides somewhat less control
599 over archives. The only purpose of the command language is to ease the
600 transition to @sc{gnu} @command{ar} for developers who already have scripts
601 written for the MRI ``librarian'' program.
603 The syntax for the @command{ar} command language is straightforward:
606 commands are recognized in upper or lower case; for example, @code{LIST}
607 is the same as @code{list}. In the following descriptions, commands are
608 shown in upper case for clarity.
611 a single command may appear on each line; it is the first word on the
615 empty lines are allowed, and have no effect.
618 comments are allowed; text after either of the characters @samp{*}
619 or @samp{;} is ignored.
622 Whenever you use a list of names as part of the argument to an @command{ar}
623 command, you can separate the individual names with either commas or
624 blanks. Commas are shown in the explanations below, for clarity.
627 @samp{+} is used as a line continuation character; if @samp{+} appears
628 at the end of a line, the text on the following line is considered part
629 of the current command.
632 Here are the commands you can use in @command{ar} scripts, or when using
633 @command{ar} interactively. Three of them have special significance:
635 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
636 a temporary file required for most of the other commands.
638 @code{SAVE} commits the changes so far specified by the script. Prior
639 to @code{SAVE}, commands affect only the temporary copy of the current
643 @item ADDLIB @var{archive}
644 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
645 Add all the contents of @var{archive} (or, if specified, each named
646 @var{module} from @var{archive}) to the current archive.
648 Requires prior use of @code{OPEN} or @code{CREATE}.
650 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
651 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
652 @c else like "ar q..."
653 Add each named @var{member} as a module in the current archive.
655 Requires prior use of @code{OPEN} or @code{CREATE}.
658 Discard the contents of the current archive, canceling the effect of
659 any operations since the last @code{SAVE}. May be executed (with no
660 effect) even if no current archive is specified.
662 @item CREATE @var{archive}
663 Creates an archive, and makes it the current archive (required for many
664 other commands). The new archive is created with a temporary name; it
665 is not actually saved as @var{archive} until you use @code{SAVE}.
666 You can overwrite existing archives; similarly, the contents of any
667 existing file named @var{archive} will not be destroyed until @code{SAVE}.
669 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
670 Delete each listed @var{module} from the current archive; equivalent to
671 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
673 Requires prior use of @code{OPEN} or @code{CREATE}.
675 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
676 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
677 List each named @var{module} present in @var{archive}. The separate
678 command @code{VERBOSE} specifies the form of the output: when verbose
679 output is off, output is like that of @samp{ar -t @var{archive}
680 @var{module}@dots{}}. When verbose output is on, the listing is like
681 @samp{ar -tv @var{archive} @var{module}@dots{}}.
683 Output normally goes to the standard output stream; however, if you
684 specify @var{outputfile} as a final argument, @command{ar} directs the
688 Exit from @command{ar}, with a @code{0} exit code to indicate successful
689 completion. This command does not save the output file; if you have
690 changed the current archive since the last @code{SAVE} command, those
693 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
694 Extract each named @var{module} from the current archive, writing them
695 into the current directory as separate files. Equivalent to @samp{ar -x
696 @var{archive} @var{module}@dots{}}.
698 Requires prior use of @code{OPEN} or @code{CREATE}.
701 @c FIXME Tokens but no commands???
708 Display full contents of the current archive, in ``verbose'' style
709 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
710 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
711 enhancement, rather than present for MRI compatibility.)
713 Requires prior use of @code{OPEN} or @code{CREATE}.
715 @item OPEN @var{archive}
716 Opens an existing archive for use as the current archive (required for
717 many other commands). Any changes as the result of subsequent commands
718 will not actually affect @var{archive} until you next use @code{SAVE}.
720 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
721 In the current archive, replace each existing @var{module} (named in
722 the @code{REPLACE} arguments) from files in the current working directory.
723 To execute this command without errors, both the file, and the module in
724 the current archive, must exist.
726 Requires prior use of @code{OPEN} or @code{CREATE}.
729 Toggle an internal flag governing the output from @code{DIRECTORY}.
730 When the flag is on, @code{DIRECTORY} output matches output from
731 @samp{ar -tv }@dots{}.
734 Commit your changes to the current archive, and actually save it as a
735 file with the name specified in the last @code{CREATE} or @code{OPEN}
738 Requires prior use of @code{OPEN} or @code{CREATE}.
747 The @sc{gnu} linker @command{ld} is now described in a separate manual.
748 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
756 @c man title nm list symbols from object files
759 @c man begin SYNOPSIS nm
760 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
761 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
762 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
763 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
764 [@option{-l}|@option{--line-numbers}] [@option{-n}|@option{-v}|@option{--numeric-sort}]
765 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
766 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
767 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
768 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
769 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
770 [@option{--plugin} @var{name}] [@option{--size-sort}] [@option{--special-syms}]
771 [@option{--synthetic}] [@option{--with-symbol-versions}] [@option{--target=}@var{bfdname}]
772 [@var{objfile}@dots{}]
776 @c man begin DESCRIPTION nm
777 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
778 If no object files are listed as arguments, @command{nm} assumes the file
781 For each symbol, @command{nm} shows:
785 The symbol value, in the radix selected by options (see below), or
786 hexadecimal by default.
789 The symbol type. At least the following types are used; others are, as
790 well, depending on the object file format. If lowercase, the symbol is
791 usually local; if uppercase, the symbol is global (external). There
792 are however a few lowercase symbols that are shown for special global
793 symbols (@code{u}, @code{v} and @code{w}).
795 @c Some more detail on exactly what these symbol types are used for
799 The symbol's value is absolute, and will not be changed by further
804 The symbol is in the uninitialized data section (known as BSS).
807 The symbol is common. Common symbols are uninitialized data. When
808 linking, multiple common symbols may appear with the same name. If the
809 symbol is defined anywhere, the common symbols are treated as undefined
812 For more details on common symbols, see the discussion of
813 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
818 The symbol is in the initialized data section.
822 The symbol is in an initialized data section for small objects. Some
823 object file formats permit more efficient access to small data objects,
824 such as a global int variable as opposed to a large global array.
827 For PE format files this indicates that the symbol is in a section
828 specific to the implementation of DLLs. For ELF format files this
829 indicates that the symbol is an indirect function. This is a GNU
830 extension to the standard set of ELF symbol types. It indicates a
831 symbol which if referenced by a relocation does not evaluate to its
832 address, but instead must be invoked at runtime. The runtime
833 execution will then return the value to be used in the relocation.
836 The symbol is an indirect reference to another symbol.
839 The symbol is a debugging symbol.
842 The symbols is in a stack unwind section.
846 The symbol is in a read only data section.
850 The symbol is in an uninitialized data section for small objects.
854 The symbol is in the text (code) section.
857 The symbol is undefined.
860 The symbol is a unique global symbol. This is a GNU extension to the
861 standard set of ELF symbol bindings. For such a symbol the dynamic linker
862 will make sure that in the entire process there is just one symbol with
863 this name and type in use.
867 The symbol is a weak object. When a weak defined symbol is linked with
868 a normal defined symbol, the normal defined symbol is used with no error.
869 When a weak undefined symbol is linked and the symbol is not defined,
870 the value of the weak symbol becomes zero with no error. On some
871 systems, uppercase indicates that a default value has been specified.
875 The symbol is a weak symbol that has not been specifically tagged as a
876 weak object symbol. When a weak defined symbol is linked with a normal
877 defined symbol, the normal defined symbol is used with no error.
878 When a weak undefined symbol is linked and the symbol is not defined,
879 the value of the symbol is determined in a system-specific manner without
880 error. On some systems, uppercase indicates that a default value has been
884 The symbol is a stabs symbol in an a.out object file. In this case, the
885 next values printed are the stabs other field, the stabs desc field, and
886 the stab type. Stabs symbols are used to hold debugging information.
889 The symbol type is unknown, or object file format specific.
898 @c man begin OPTIONS nm
899 The long and short forms of options, shown here as alternatives, are
905 @itemx --print-file-name
906 @cindex input file name
908 @cindex source file name
909 Precede each symbol by the name of the input file (or archive member)
910 in which it was found, rather than identifying the input file once only,
911 before all of its symbols.
915 @cindex debugging symbols
916 Display all symbols, even debugger-only symbols; normally these are not
920 @cindex @command{nm} format
921 @cindex @command{nm} compatibility
922 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
925 @itemx --demangle[=@var{style}]
926 @cindex demangling in nm
927 Decode (@dfn{demangle}) low-level symbol names into user-level names.
928 Besides removing any initial underscore prepended by the system, this
929 makes C++ function names readable. Different compilers have different
930 mangling styles. The optional demangling style argument can be used to
931 choose an appropriate demangling style for your compiler. @xref{c++filt},
932 for more information on demangling.
935 Do not demangle low-level symbol names. This is the default.
939 @cindex dynamic symbols
940 Display the dynamic symbols rather than the normal symbols. This is
941 only meaningful for dynamic objects, such as certain types of shared
944 @item -f @var{format}
945 @itemx --format=@var{format}
946 @cindex @command{nm} format
947 @cindex @command{nm} compatibility
948 Use the output format @var{format}, which can be @code{bsd},
949 @code{sysv}, or @code{posix}. The default is @code{bsd}.
950 Only the first character of @var{format} is significant; it can be
951 either upper or lower case.
955 @cindex external symbols
956 Display only external symbols.
960 Show a summary of the options to @command{nm} and exit.
963 @itemx --line-numbers
964 @cindex symbol line numbers
965 For each symbol, use debugging information to try to find a filename and
966 line number. For a defined symbol, look for the line number of the
967 address of the symbol. For an undefined symbol, look for the line
968 number of a relocation entry which refers to the symbol. If line number
969 information can be found, print it after the other symbol information.
973 @itemx --numeric-sort
974 Sort symbols numerically by their addresses, rather than alphabetically
979 @cindex sorting symbols
980 Do not bother to sort the symbols in any order; print them in the order
985 Use the POSIX.2 standard output format instead of the default format.
986 Equivalent to @samp{-f posix}.
989 @itemx --reverse-sort
990 Reverse the order of the sort (whether numeric or alphabetic); let the
995 Print both value and size of defined symbols for the @code{bsd} output style.
996 This option has no effect for object formats that do not record symbol
997 sizes, unless @samp{--size-sort} is also used in which case a
998 calculated size is displayed.
1001 @itemx --print-armap
1002 @cindex symbol index, listing
1003 When listing symbols from archive members, include the index: a mapping
1004 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
1005 contain definitions for which names.
1007 @item -t @var{radix}
1008 @itemx --radix=@var{radix}
1009 Use @var{radix} as the radix for printing the symbol values. It must be
1010 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
1013 @itemx --undefined-only
1014 @cindex external symbols
1015 @cindex undefined symbols
1016 Display only undefined symbols (those external to each object file).
1020 Show the version number of @command{nm} and exit.
1023 This option is ignored for compatibility with the AIX version of
1024 @command{nm}. It takes one parameter which must be the string
1025 @option{32_64}. The default mode of AIX @command{nm} corresponds
1026 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1028 @item --defined-only
1029 @cindex external symbols
1030 @cindex undefined symbols
1031 Display only defined symbols for each object file.
1033 @item --plugin @var{name}
1035 Load the plugin called @var{name} to add support for extra target
1036 types. This option is only available if the toolchain has been built
1037 with plugin support enabled.
1039 If @option{--plugin} is not provided, but plugin support has been
1040 enabled then @command{nm} iterates over the files in
1041 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
1042 plugin that claims the object in question is used.
1044 Please note that this plugin search directory is @emph{not} the one
1045 used by @command{ld}'s @option{-plugin} option. In order to make
1046 @command{nm} use the linker plugin it must be copied into the
1047 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
1048 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
1049 based compilations it is called @file{LLVMgold.so}. The GCC plugin
1050 is always backwards compatible with earlier versions, so it is
1051 sufficient to just copy the newest one.
1054 Sort symbols by size. For ELF objects symbol sizes are read from the
1055 ELF, for other object types the symbol sizes are computed as the
1056 difference between the value of the symbol and the value of the symbol
1057 with the next higher value. If the @code{bsd} output format is used
1058 the size of the symbol is printed, rather than the value, and
1059 @samp{-S} must be used in order both size and value to be printed.
1061 @item --special-syms
1062 Display symbols which have a target-specific special meaning. These
1063 symbols are usually used by the target for some special processing and
1064 are not normally helpful when included in the normal symbol lists.
1065 For example for ARM targets this option would skip the mapping symbols
1066 used to mark transitions between ARM code, THUMB code and data.
1069 Include synthetic symbols in the output. These are special symbols
1070 created by the linker for various purposes. They are not shown by
1071 default since they are not part of the binary's original source code.
1073 @item --with-symbol-versions
1074 Enables the display of symbol version information if any exists. The
1075 version string is displayed as a suffix to the symbol name, preceeded by
1076 an @@ character. For example @samp{foo@@VER_1}. If the version is
1077 the default version to be used when resolving unversioned references
1078 to the symbol then it is displayed as a suffix preceeded by two @@
1079 characters. For example @samp{foo@@@@VER_2}.
1081 @item --target=@var{bfdname}
1082 @cindex object code format
1083 Specify an object code format other than your system's default format.
1084 @xref{Target Selection}, for more information.
1091 @c man begin SEEALSO nm
1092 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1099 @c man title objcopy copy and translate object files
1102 @c man begin SYNOPSIS objcopy
1103 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1104 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1105 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1106 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1107 [@option{-S}|@option{--strip-all}]
1108 [@option{-g}|@option{--strip-debug}]
1109 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1110 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1111 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1112 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1113 [@option{--localize-hidden}]
1114 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1115 [@option{--globalize-symbol=}@var{symbolname}]
1116 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1117 [@option{-w}|@option{--wildcard}]
1118 [@option{-x}|@option{--discard-all}]
1119 [@option{-X}|@option{--discard-locals}]
1120 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1121 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1122 [@option{--interleave-width=}@var{width}]
1123 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1124 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1125 [@option{--remove-relocations=}@var{sectionpattern}]
1126 [@option{-p}|@option{--preserve-dates}]
1127 [@option{-D}|@option{--enable-deterministic-archives}]
1128 [@option{-U}|@option{--disable-deterministic-archives}]
1129 [@option{--debugging}]
1130 [@option{--gap-fill=}@var{val}]
1131 [@option{--pad-to=}@var{address}]
1132 [@option{--set-start=}@var{val}]
1133 [@option{--adjust-start=}@var{incr}]
1134 [@option{--change-addresses=}@var{incr}]
1135 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1136 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1137 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1138 [@option{--change-warnings}] [@option{--no-change-warnings}]
1139 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1140 [@option{--add-section} @var{sectionname}=@var{filename}]
1141 [@option{--dump-section} @var{sectionname}=@var{filename}]
1142 [@option{--update-section} @var{sectionname}=@var{filename}]
1143 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1144 [@option{--long-section-names} @{enable,disable,keep@}]
1145 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1146 [@option{--reverse-bytes=}@var{num}]
1147 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1148 [@option{--redefine-sym} @var{old}=@var{new}]
1149 [@option{--redefine-syms=}@var{filename}]
1151 [@option{--keep-symbols=}@var{filename}]
1152 [@option{--strip-symbols=}@var{filename}]
1153 [@option{--strip-unneeded-symbols=}@var{filename}]
1154 [@option{--keep-global-symbols=}@var{filename}]
1155 [@option{--localize-symbols=}@var{filename}]
1156 [@option{--globalize-symbols=}@var{filename}]
1157 [@option{--weaken-symbols=}@var{filename}]
1158 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1159 [@option{--alt-machine-code=}@var{index}]
1160 [@option{--prefix-symbols=}@var{string}]
1161 [@option{--prefix-sections=}@var{string}]
1162 [@option{--prefix-alloc-sections=}@var{string}]
1163 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1164 [@option{--keep-file-symbols}]
1165 [@option{--only-keep-debug}]
1166 [@option{--strip-dwo}]
1167 [@option{--extract-dwo}]
1168 [@option{--extract-symbol}]
1169 [@option{--writable-text}]
1170 [@option{--readonly-text}]
1173 [@option{--file-alignment=}@var{num}]
1174 [@option{--heap=}@var{size}]
1175 [@option{--image-base=}@var{address}]
1176 [@option{--section-alignment=}@var{num}]
1177 [@option{--stack=}@var{size}]
1178 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1179 [@option{--compress-debug-sections}]
1180 [@option{--decompress-debug-sections}]
1181 [@option{--elf-stt-common=@var{val}}]
1182 [@option{-v}|@option{--verbose}]
1183 [@option{-V}|@option{--version}]
1184 [@option{--help}] [@option{--info}]
1185 @var{infile} [@var{outfile}]
1189 @c man begin DESCRIPTION objcopy
1190 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1191 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1192 read and write the object files. It can write the destination object
1193 file in a format different from that of the source object file. The
1194 exact behavior of @command{objcopy} is controlled by command-line options.
1195 Note that @command{objcopy} should be able to copy a fully linked file
1196 between any two formats. However, copying a relocatable object file
1197 between any two formats may not work as expected.
1199 @command{objcopy} creates temporary files to do its translations and
1200 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1201 translation work; it has access to all the formats described in @sc{bfd}
1202 and thus is able to recognize most formats without being told
1203 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1205 @command{objcopy} can be used to generate S-records by using an output
1206 target of @samp{srec} (e.g., use @samp{-O srec}).
1208 @command{objcopy} can be used to generate a raw binary file by using an
1209 output target of @samp{binary} (e.g., use @option{-O binary}). When
1210 @command{objcopy} generates a raw binary file, it will essentially produce
1211 a memory dump of the contents of the input object file. All symbols and
1212 relocation information will be discarded. The memory dump will start at
1213 the load address of the lowest section copied into the output file.
1215 When generating an S-record or a raw binary file, it may be helpful to
1216 use @option{-S} to remove sections containing debugging information. In
1217 some cases @option{-R} will be useful to remove sections which contain
1218 information that is not needed by the binary file.
1220 Note---@command{objcopy} is not able to change the endianness of its input
1221 files. If the input format has an endianness (some formats do not),
1222 @command{objcopy} can only copy the inputs into file formats that have the
1223 same endianness or which have no endianness (e.g., @samp{srec}).
1224 (However, see the @option{--reverse-bytes} option.)
1228 @c man begin OPTIONS objcopy
1232 @itemx @var{outfile}
1233 The input and output files, respectively.
1234 If you do not specify @var{outfile}, @command{objcopy} creates a
1235 temporary file and destructively renames the result with
1236 the name of @var{infile}.
1238 @item -I @var{bfdname}
1239 @itemx --input-target=@var{bfdname}
1240 Consider the source file's object format to be @var{bfdname}, rather than
1241 attempting to deduce it. @xref{Target Selection}, for more information.
1243 @item -O @var{bfdname}
1244 @itemx --output-target=@var{bfdname}
1245 Write the output file using the object format @var{bfdname}.
1246 @xref{Target Selection}, for more information.
1248 @item -F @var{bfdname}
1249 @itemx --target=@var{bfdname}
1250 Use @var{bfdname} as the object format for both the input and the output
1251 file; i.e., simply transfer data from source to destination with no
1252 translation. @xref{Target Selection}, for more information.
1254 @item -B @var{bfdarch}
1255 @itemx --binary-architecture=@var{bfdarch}
1256 Useful when transforming a architecture-less input file into an object file.
1257 In this case the output architecture can be set to @var{bfdarch}. This
1258 option will be ignored if the input file has a known @var{bfdarch}. You
1259 can access this binary data inside a program by referencing the special
1260 symbols that are created by the conversion process. These symbols are
1261 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1262 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1263 an object file and then access it in your code using these symbols.
1265 @item -j @var{sectionpattern}
1266 @itemx --only-section=@var{sectionpattern}
1267 Copy only the indicated sections from the input file to the output file.
1268 This option may be given more than once. Note that using this option
1269 inappropriately may make the output file unusable. Wildcard
1270 characters are accepted in @var{sectionpattern}.
1272 If the first character of @var{sectionpattern} is the exclamation
1273 point (!) then matching sections will not be copied, even if earlier
1274 use of @option{--only-section} on the same command line would
1275 otherwise copy it. For example:
1278 --only-section=.text.* --only-section=!.text.foo
1281 will copy all sectinos maching '.text.*' but not the section
1284 @item -R @var{sectionpattern}
1285 @itemx --remove-section=@var{sectionpattern}
1286 Remove any section matching @var{sectionpattern} from the output file.
1287 This option may be given more than once. Note that using this option
1288 inappropriately may make the output file unusable. Wildcard
1289 characters are accepted in @var{sectionpattern}. Using both the
1290 @option{-j} and @option{-R} options together results in undefined
1293 If the first character of @var{sectionpattern} is the exclamation
1294 point (!) then matching sections will not be removed even if an
1295 earlier use of @option{--remove-section} on the same command line
1296 would otherwise remove it. For example:
1299 --remove-section=.text.* --remove-section=!.text.foo
1302 will remove all sections matching the pattern '.text.*', but will not
1303 remove the section '.text.foo'.
1305 @item --remove-relocations=@var{sectionpattern}
1306 Remove relocations from the output file for any section matching
1307 @var{sectionpattern}. This option may be given more than once. Note
1308 that using this option inappropriately may make the output file
1309 unusable. Wildcard characters are accepted in @var{sectionpattern}.
1313 --remove-relocations=.text.*
1316 will remove the relocations for all sections matching the patter
1319 If the first character of @var{sectionpattern} is the exclamation
1320 point (!) then matching sections will not have their relocation
1321 removed even if an earlier use of @option{--remove-relocations} on the
1322 same command line would otherwise cause the relocations to be removed.
1326 --remove-relocations=.text.* --remove-relocations=!.text.foo
1329 will remove all relocations for sections matching the pattern
1330 '.text.*', but will not remove relocations for the section
1335 Do not copy relocation and symbol information from the source file.
1338 @itemx --strip-debug
1339 Do not copy debugging symbols or sections from the source file.
1341 @item --strip-unneeded
1342 Strip all symbols that are not needed for relocation processing.
1344 @item -K @var{symbolname}
1345 @itemx --keep-symbol=@var{symbolname}
1346 When stripping symbols, keep symbol @var{symbolname} even if it would
1347 normally be stripped. This option may be given more than once.
1349 @item -N @var{symbolname}
1350 @itemx --strip-symbol=@var{symbolname}
1351 Do not copy symbol @var{symbolname} from the source file. This option
1352 may be given more than once.
1354 @item --strip-unneeded-symbol=@var{symbolname}
1355 Do not copy symbol @var{symbolname} from the source file unless it is needed
1356 by a relocation. This option may be given more than once.
1358 @item -G @var{symbolname}
1359 @itemx --keep-global-symbol=@var{symbolname}
1360 Keep only symbol @var{symbolname} global. Make all other symbols local
1361 to the file, so that they are not visible externally. This option may
1362 be given more than once.
1364 @item --localize-hidden
1365 In an ELF object, mark all symbols that have hidden or internal visibility
1366 as local. This option applies on top of symbol-specific localization options
1367 such as @option{-L}.
1369 @item -L @var{symbolname}
1370 @itemx --localize-symbol=@var{symbolname}
1371 Convert a global or weak symbol called @var{symbolname} into a local
1372 symbol, so that it is not visible externally. This option may be
1373 given more than once. Note - unique symbols are not converted.
1375 @item -W @var{symbolname}
1376 @itemx --weaken-symbol=@var{symbolname}
1377 Make symbol @var{symbolname} weak. This option may be given more than once.
1379 @item --globalize-symbol=@var{symbolname}
1380 Give symbol @var{symbolname} global scoping so that it is visible
1381 outside of the file in which it is defined. This option may be given
1386 Permit regular expressions in @var{symbolname}s used in other command
1387 line options. The question mark (?), asterisk (*), backslash (\) and
1388 square brackets ([]) operators can be used anywhere in the symbol
1389 name. If the first character of the symbol name is the exclamation
1390 point (!) then the sense of the switch is reversed for that symbol.
1397 would cause objcopy to weaken all symbols that start with ``fo''
1398 except for the symbol ``foo''.
1401 @itemx --discard-all
1402 Do not copy non-global symbols from the source file.
1403 @c FIXME any reason to prefer "non-global" to "local" here?
1406 @itemx --discard-locals
1407 Do not copy compiler-generated local symbols.
1408 (These usually start with @samp{L} or @samp{.}.)
1411 @itemx --byte=@var{byte}
1412 If interleaving has been enabled via the @option{--interleave} option
1413 then start the range of bytes to keep at the @var{byte}th byte.
1414 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1415 @var{breadth} is the value given by the @option{--interleave} option.
1417 @item -i [@var{breadth}]
1418 @itemx --interleave[=@var{breadth}]
1419 Only copy a range out of every @var{breadth} bytes. (Header data is
1420 not affected). Select which byte in the range begins the copy with
1421 the @option{--byte} option. Select the width of the range with the
1422 @option{--interleave-width} option.
1424 This option is useful for creating files to program @sc{rom}. It is
1425 typically used with an @code{srec} output target. Note that
1426 @command{objcopy} will complain if you do not specify the
1427 @option{--byte} option as well.
1429 The default interleave breadth is 4, so with @option{--byte} set to 0,
1430 @command{objcopy} would copy the first byte out of every four bytes
1431 from the input to the output.
1433 @item --interleave-width=@var{width}
1434 When used with the @option{--interleave} option, copy @var{width}
1435 bytes at a time. The start of the range of bytes to be copied is set
1436 by the @option{--byte} option, and the extent of the range is set with
1437 the @option{--interleave} option.
1439 The default value for this option is 1. The value of @var{width} plus
1440 the @var{byte} value set by the @option{--byte} option must not exceed
1441 the interleave breadth set by the @option{--interleave} option.
1443 This option can be used to create images for two 16-bit flashes interleaved
1444 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1445 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1446 commands. If the input was '12345678' then the outputs would be
1447 '1256' and '3478' respectively.
1450 @itemx --preserve-dates
1451 Set the access and modification dates of the output file to be the same
1452 as those of the input file.
1455 @itemx --enable-deterministic-archives
1456 @cindex deterministic archives
1457 @kindex --enable-deterministic-archives
1458 Operate in @emph{deterministic} mode. When copying archive members
1459 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1460 and use consistent file modes for all files.
1462 If @file{binutils} was configured with
1463 @option{--enable-deterministic-archives}, then this mode is on by default.
1464 It can be disabled with the @samp{-U} option, below.
1467 @itemx --disable-deterministic-archives
1468 @cindex deterministic archives
1469 @kindex --enable-deterministic-archives
1470 Do @emph{not} operate in @emph{deterministic} mode. This is the
1471 inverse of the @option{-D} option, above: when copying archive members
1472 and writing the archive index, use their actual UID, GID, timestamp,
1473 and file mode values.
1475 This is the default unless @file{binutils} was configured with
1476 @option{--enable-deterministic-archives}.
1479 Convert debugging information, if possible. This is not the default
1480 because only certain debugging formats are supported, and the
1481 conversion process can be time consuming.
1483 @item --gap-fill @var{val}
1484 Fill gaps between sections with @var{val}. This operation applies to
1485 the @emph{load address} (LMA) of the sections. It is done by increasing
1486 the size of the section with the lower address, and filling in the extra
1487 space created with @var{val}.
1489 @item --pad-to @var{address}
1490 Pad the output file up to the load address @var{address}. This is
1491 done by increasing the size of the last section. The extra space is
1492 filled in with the value specified by @option{--gap-fill} (default zero).
1494 @item --set-start @var{val}
1495 Set the start address of the new file to @var{val}. Not all object file
1496 formats support setting the start address.
1498 @item --change-start @var{incr}
1499 @itemx --adjust-start @var{incr}
1500 @cindex changing start address
1501 Change the start address by adding @var{incr}. Not all object file
1502 formats support setting the start address.
1504 @item --change-addresses @var{incr}
1505 @itemx --adjust-vma @var{incr}
1506 @cindex changing object addresses
1507 Change the VMA and LMA addresses of all sections, as well as the start
1508 address, by adding @var{incr}. Some object file formats do not permit
1509 section addresses to be changed arbitrarily. Note that this does not
1510 relocate the sections; if the program expects sections to be loaded at a
1511 certain address, and this option is used to change the sections such
1512 that they are loaded at a different address, the program may fail.
1514 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1515 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1516 @cindex changing section address
1517 Set or change both the VMA address and the LMA address of any section
1518 matching @var{sectionpattern}. If @samp{=} is used, the section
1519 address is set to @var{val}. Otherwise, @var{val} is added to or
1520 subtracted from the section address. See the comments under
1521 @option{--change-addresses}, above. If @var{sectionpattern} does not
1522 match any sections in the input file, a warning will be issued, unless
1523 @option{--no-change-warnings} is used.
1525 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1526 @cindex changing section LMA
1527 Set or change the LMA address of any sections matching
1528 @var{sectionpattern}. The LMA address is the address where the
1529 section will be loaded into memory at program load time. Normally
1530 this is the same as the VMA address, which is the address of the
1531 section at program run time, but on some systems, especially those
1532 where a program is held in ROM, the two can be different. If @samp{=}
1533 is used, the section address is set to @var{val}. Otherwise,
1534 @var{val} is added to or subtracted from the section address. See the
1535 comments under @option{--change-addresses}, above. If
1536 @var{sectionpattern} does not match any sections in the input file, a
1537 warning will be issued, unless @option{--no-change-warnings} is used.
1539 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1540 @cindex changing section VMA
1541 Set or change the VMA address of any section matching
1542 @var{sectionpattern}. The VMA address is the address where the
1543 section will be located once the program has started executing.
1544 Normally this is the same as the LMA address, which is the address
1545 where the section will be loaded into memory, but on some systems,
1546 especially those where a program is held in ROM, the two can be
1547 different. If @samp{=} is used, the section address is set to
1548 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1549 section address. See the comments under @option{--change-addresses},
1550 above. If @var{sectionpattern} does not match any sections in the
1551 input file, a warning will be issued, unless
1552 @option{--no-change-warnings} is used.
1554 @item --change-warnings
1555 @itemx --adjust-warnings
1556 If @option{--change-section-address} or @option{--change-section-lma} or
1557 @option{--change-section-vma} is used, and the section pattern does not
1558 match any sections, issue a warning. This is the default.
1560 @item --no-change-warnings
1561 @itemx --no-adjust-warnings
1562 Do not issue a warning if @option{--change-section-address} or
1563 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1564 if the section pattern does not match any sections.
1566 @item --set-section-flags @var{sectionpattern}=@var{flags}
1567 Set the flags for any sections matching @var{sectionpattern}. The
1568 @var{flags} argument is a comma separated string of flag names. The
1569 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1570 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1571 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1572 for a section which does not have contents, but it is not meaningful
1573 to clear the @samp{contents} flag of a section which does have
1574 contents--just remove the section instead. Not all flags are
1575 meaningful for all object file formats.
1577 @item --add-section @var{sectionname}=@var{filename}
1578 Add a new section named @var{sectionname} while copying the file. The
1579 contents of the new section are taken from the file @var{filename}. The
1580 size of the section will be the size of the file. This option only
1581 works on file formats which can support sections with arbitrary names.
1582 Note - it may be necessary to use the @option{--set-section-flags}
1583 option to set the attributes of the newly created section.
1585 @item --dump-section @var{sectionname}=@var{filename}
1586 Place the contents of section named @var{sectionname} into the file
1587 @var{filename}, overwriting any contents that may have been there
1588 previously. This option is the inverse of @option{--add-section}.
1589 This option is similar to the @option{--only-section} option except
1590 that it does not create a formatted file, it just dumps the contents
1591 as raw binary data, without applying any relocations. The option can
1592 be specified more than once.
1594 @item --update-section @var{sectionname}=@var{filename}
1595 Replace the existing contents of a section named @var{sectionname}
1596 with the contents of file @var{filename}. The size of the section
1597 will be adjusted to the size of the file. The section flags for
1598 @var{sectionname} will be unchanged. For ELF format files the section
1599 to segment mapping will also remain unchanged, something which is not
1600 possible using @option{--remove-section} followed by
1601 @option{--add-section}. The option can be specified more than once.
1603 Note - it is possible to use @option{--rename-section} and
1604 @option{--update-section} to both update and rename a section from one
1605 command line. In this case, pass the original section name to
1606 @option{--update-section}, and the original and new section names to
1607 @option{--rename-section}.
1609 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1610 Add a new symbol named @var{name} while copying the file. This option may be
1611 specified multiple times. If the @var{section} is given, the symbol will be
1612 associated with and relative to that section, otherwise it will be an ABS
1613 symbol. Specifying an undefined section will result in a fatal error. There
1614 is no check for the value, it will be taken as specified. Symbol flags can
1615 be specified and not all flags will be meaningful for all object file
1616 formats. By default, the symbol will be global. The special flag
1617 'before=@var{othersym}' will insert the new symbol in front of the specified
1618 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1619 symbol table in the order they appear.
1621 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1622 Rename a section from @var{oldname} to @var{newname}, optionally
1623 changing the section's flags to @var{flags} in the process. This has
1624 the advantage over usng a linker script to perform the rename in that
1625 the output stays as an object file and does not become a linked
1628 This option is particularly helpful when the input format is binary,
1629 since this will always create a section called .data. If for example,
1630 you wanted instead to create a section called .rodata containing binary
1631 data you could use the following command line to achieve it:
1634 objcopy -I binary -O <output_format> -B <architecture> \
1635 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1636 <input_binary_file> <output_object_file>
1639 @item --long-section-names @{enable,disable,keep@}
1640 Controls the handling of long section names when processing @code{COFF}
1641 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1642 is to preserve long section names if any are present in the input file.
1643 The @samp{enable} and @samp{disable} options forcibly enable or disable
1644 the use of long section names in the output object; when @samp{disable}
1645 is in effect, any long section names in the input object will be truncated.
1646 The @samp{enable} option will only emit long section names if any are
1647 present in the inputs; this is mostly the same as @samp{keep}, but it
1648 is left undefined whether the @samp{enable} option might force the
1649 creation of an empty string table in the output file.
1651 @item --change-leading-char
1652 Some object file formats use special characters at the start of
1653 symbols. The most common such character is underscore, which compilers
1654 often add before every symbol. This option tells @command{objcopy} to
1655 change the leading character of every symbol when it converts between
1656 object file formats. If the object file formats use the same leading
1657 character, this option has no effect. Otherwise, it will add a
1658 character, or remove a character, or change a character, as
1661 @item --remove-leading-char
1662 If the first character of a global symbol is a special symbol leading
1663 character used by the object file format, remove the character. The
1664 most common symbol leading character is underscore. This option will
1665 remove a leading underscore from all global symbols. This can be useful
1666 if you want to link together objects of different file formats with
1667 different conventions for symbol names. This is different from
1668 @option{--change-leading-char} because it always changes the symbol name
1669 when appropriate, regardless of the object file format of the output
1672 @item --reverse-bytes=@var{num}
1673 Reverse the bytes in a section with output contents. A section length must
1674 be evenly divisible by the value given in order for the swap to be able to
1675 take place. Reversing takes place before the interleaving is performed.
1677 This option is used typically in generating ROM images for problematic
1678 target systems. For example, on some target boards, the 32-bit words
1679 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1680 regardless of the CPU byte order. Depending on the programming model, the
1681 endianness of the ROM may need to be modified.
1683 Consider a simple file with a section containing the following eight
1684 bytes: @code{12345678}.
1686 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1687 output file would be ordered @code{21436587}.
1689 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1690 output file would be ordered @code{43218765}.
1692 By using @samp{--reverse-bytes=2} for the above example, followed by
1693 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1694 output file would be ordered @code{34127856}.
1696 @item --srec-len=@var{ival}
1697 Meaningful only for srec output. Set the maximum length of the Srecords
1698 being produced to @var{ival}. This length covers both address, data and
1701 @item --srec-forceS3
1702 Meaningful only for srec output. Avoid generation of S1/S2 records,
1703 creating S3-only record format.
1705 @item --redefine-sym @var{old}=@var{new}
1706 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1707 when one is trying link two things together for which you have no
1708 source, and there are name collisions.
1710 @item --redefine-syms=@var{filename}
1711 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1712 listed in the file @var{filename}. @var{filename} is simply a flat file,
1713 with one symbol pair per line. Line comments may be introduced by the hash
1714 character. This option may be given more than once.
1717 Change all global symbols in the file to be weak. This can be useful
1718 when building an object which will be linked against other objects using
1719 the @option{-R} option to the linker. This option is only effective when
1720 using an object file format which supports weak symbols.
1722 @item --keep-symbols=@var{filename}
1723 Apply @option{--keep-symbol} option to each symbol listed in the file
1724 @var{filename}. @var{filename} is simply a flat file, with one symbol
1725 name per line. Line comments may be introduced by the hash character.
1726 This option may be given more than once.
1728 @item --strip-symbols=@var{filename}
1729 Apply @option{--strip-symbol} option to each symbol listed in the file
1730 @var{filename}. @var{filename} is simply a flat file, with one symbol
1731 name per line. Line comments may be introduced by the hash character.
1732 This option may be given more than once.
1734 @item --strip-unneeded-symbols=@var{filename}
1735 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1736 the file @var{filename}. @var{filename} is simply a flat file, with one
1737 symbol name per line. Line comments may be introduced by the hash
1738 character. This option may be given more than once.
1740 @item --keep-global-symbols=@var{filename}
1741 Apply @option{--keep-global-symbol} option to each symbol listed in the
1742 file @var{filename}. @var{filename} is simply a flat file, with one
1743 symbol name per line. Line comments may be introduced by the hash
1744 character. This option may be given more than once.
1746 @item --localize-symbols=@var{filename}
1747 Apply @option{--localize-symbol} option to each symbol listed in the file
1748 @var{filename}. @var{filename} is simply a flat file, with one symbol
1749 name per line. Line comments may be introduced by the hash character.
1750 This option may be given more than once.
1752 @item --globalize-symbols=@var{filename}
1753 Apply @option{--globalize-symbol} option to each symbol listed in the file
1754 @var{filename}. @var{filename} is simply a flat file, with one symbol
1755 name per line. Line comments may be introduced by the hash character.
1756 This option may be given more than once.
1758 @item --weaken-symbols=@var{filename}
1759 Apply @option{--weaken-symbol} option to each symbol listed in the file
1760 @var{filename}. @var{filename} is simply a flat file, with one symbol
1761 name per line. Line comments may be introduced by the hash character.
1762 This option may be given more than once.
1764 @item --alt-machine-code=@var{index}
1765 If the output architecture has alternate machine codes, use the
1766 @var{index}th code instead of the default one. This is useful in case
1767 a machine is assigned an official code and the tool-chain adopts the
1768 new code, but other applications still depend on the original code
1769 being used. For ELF based architectures if the @var{index}
1770 alternative does not exist then the value is treated as an absolute
1771 number to be stored in the e_machine field of the ELF header.
1773 @item --writable-text
1774 Mark the output text as writable. This option isn't meaningful for all
1775 object file formats.
1777 @item --readonly-text
1778 Make the output text write protected. This option isn't meaningful for all
1779 object file formats.
1782 Mark the output file as demand paged. This option isn't meaningful for all
1783 object file formats.
1786 Mark the output file as impure. This option isn't meaningful for all
1787 object file formats.
1789 @item --prefix-symbols=@var{string}
1790 Prefix all symbols in the output file with @var{string}.
1792 @item --prefix-sections=@var{string}
1793 Prefix all section names in the output file with @var{string}.
1795 @item --prefix-alloc-sections=@var{string}
1796 Prefix all the names of all allocated sections in the output file with
1799 @item --add-gnu-debuglink=@var{path-to-file}
1800 Creates a .gnu_debuglink section which contains a reference to
1801 @var{path-to-file} and adds it to the output file. Note: the file at
1802 @var{path-to-file} must exist. Part of the process of adding the
1803 .gnu_debuglink section involves embedding a checksum of the contents
1804 of the debug info file into the section.
1806 If the debug info file is built in one location but it is going to be
1807 installed at a later time into a different location then do not use
1808 the path to the installed location. The @option{--add-gnu-debuglink}
1809 option will fail because the installed file does not exist yet.
1810 Instead put the debug info file in the current directory and use the
1811 @option{--add-gnu-debuglink} option without any directory components,
1815 objcopy --add-gnu-debuglink=foo.debug
1818 At debug time the debugger will attempt to look for the separate debug
1819 info file in a set of known locations. The exact set of these
1820 locations varies depending upon the distribution being used, but it
1825 @item * The same directory as the executable.
1827 @item * A sub-directory of the directory containing the executable
1830 @item * A global debug directory such as /usr/lib/debug.
1833 As long as the debug info file has been installed into one of these
1834 locations before the debugger is run everything should work
1837 @item --keep-file-symbols
1838 When stripping a file, perhaps with @option{--strip-debug} or
1839 @option{--strip-unneeded}, retain any symbols specifying source file names,
1840 which would otherwise get stripped.
1842 @item --only-keep-debug
1843 Strip a file, removing contents of any sections that would not be
1844 stripped by @option{--strip-debug} and leaving the debugging sections
1845 intact. In ELF files, this preserves all note sections in the output.
1847 Note - the section headers of the stripped sections are preserved,
1848 including their sizes, but the contents of the section are discarded.
1849 The section headers are preserved so that other tools can match up the
1850 debuginfo file with the real executable, even if that executable has
1851 been relocated to a different address space.
1853 The intention is that this option will be used in conjunction with
1854 @option{--add-gnu-debuglink} to create a two part executable. One a
1855 stripped binary which will occupy less space in RAM and in a
1856 distribution and the second a debugging information file which is only
1857 needed if debugging abilities are required. The suggested procedure
1858 to create these files is as follows:
1861 @item Link the executable as normal. Assuming that is is called
1863 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1864 create a file containing the debugging info.
1865 @item Run @code{objcopy --strip-debug foo} to create a
1866 stripped executable.
1867 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1868 to add a link to the debugging info into the stripped executable.
1871 Note---the choice of @code{.dbg} as an extension for the debug info
1872 file is arbitrary. Also the @code{--only-keep-debug} step is
1873 optional. You could instead do this:
1876 @item Link the executable as normal.
1877 @item Copy @code{foo} to @code{foo.full}
1878 @item Run @code{objcopy --strip-debug foo}
1879 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1882 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1883 full executable. It does not have to be a file created by the
1884 @option{--only-keep-debug} switch.
1886 Note---this switch is only intended for use on fully linked files. It
1887 does not make sense to use it on object files where the debugging
1888 information may be incomplete. Besides the gnu_debuglink feature
1889 currently only supports the presence of one filename containing
1890 debugging information, not multiple filenames on a one-per-object-file
1894 Remove the contents of all DWARF .dwo sections, leaving the
1895 remaining debugging sections and all symbols intact.
1896 This option is intended for use by the compiler as part of
1897 the @option{-gsplit-dwarf} option, which splits debug information
1898 between the .o file and a separate .dwo file. The compiler
1899 generates all debug information in the same file, then uses
1900 the @option{--extract-dwo} option to copy the .dwo sections to
1901 the .dwo file, then the @option{--strip-dwo} option to remove
1902 those sections from the original .o file.
1905 Extract the contents of all DWARF .dwo sections. See the
1906 @option{--strip-dwo} option for more information.
1908 @item --file-alignment @var{num}
1909 Specify the file alignment. Sections in the file will always begin at
1910 file offsets which are multiples of this number. This defaults to
1912 [This option is specific to PE targets.]
1914 @item --heap @var{reserve}
1915 @itemx --heap @var{reserve},@var{commit}
1916 Specify the number of bytes of memory to reserve (and optionally commit)
1917 to be used as heap for this program.
1918 [This option is specific to PE targets.]
1920 @item --image-base @var{value}
1921 Use @var{value} as the base address of your program or dll. This is
1922 the lowest memory location that will be used when your program or dll
1923 is loaded. To reduce the need to relocate and improve performance of
1924 your dlls, each should have a unique base address and not overlap any
1925 other dlls. The default is 0x400000 for executables, and 0x10000000
1927 [This option is specific to PE targets.]
1929 @item --section-alignment @var{num}
1930 Sets the section alignment. Sections in memory will always begin at
1931 addresses which are a multiple of this number. Defaults to 0x1000.
1932 [This option is specific to PE targets.]
1934 @item --stack @var{reserve}
1935 @itemx --stack @var{reserve},@var{commit}
1936 Specify the number of bytes of memory to reserve (and optionally commit)
1937 to be used as stack for this program.
1938 [This option is specific to PE targets.]
1940 @item --subsystem @var{which}
1941 @itemx --subsystem @var{which}:@var{major}
1942 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1943 Specifies the subsystem under which your program will execute. The
1944 legal values for @var{which} are @code{native}, @code{windows},
1945 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1946 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1947 the subsystem version also. Numeric values are also accepted for
1949 [This option is specific to PE targets.]
1951 @item --extract-symbol
1952 Keep the file's section flags and symbols but remove all section data.
1953 Specifically, the option:
1956 @item removes the contents of all sections;
1957 @item sets the size of every section to zero; and
1958 @item sets the file's start address to zero.
1961 This option is used to build a @file{.sym} file for a VxWorks kernel.
1962 It can also be a useful way of reducing the size of a @option{--just-symbols}
1965 @item --compress-debug-sections
1966 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
1967 ELF ABI. Note - if compression would actually make a section
1968 @emph{larger}, then it is not compressed.
1970 @item --compress-debug-sections=none
1971 @itemx --compress-debug-sections=zlib
1972 @itemx --compress-debug-sections=zlib-gnu
1973 @itemx --compress-debug-sections=zlib-gabi
1974 For ELF files, these options control how DWARF debug sections are
1975 compressed. @option{--compress-debug-sections=none} is equivalent
1976 to @option{--decompress-debug-sections}.
1977 @option{--compress-debug-sections=zlib} and
1978 @option{--compress-debug-sections=zlib-gabi} are equivalent to
1979 @option{--compress-debug-sections}.
1980 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
1981 sections using zlib. The debug sections are renamed to begin with
1982 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
1983 actually make a section @emph{larger}, then it is not compressed nor
1986 @item --decompress-debug-sections
1987 Decompress DWARF debug sections using zlib. The original section
1988 names of the compressed sections are restored.
1990 @item --elf-stt-common=yes
1991 @itemx --elf-stt-common=no
1992 For ELF files, these options control whether common symbols should be
1993 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
1994 @option{--elf-stt-common=yes} converts common symbol type to
1995 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
1996 type to @code{STT_OBJECT}.
2000 Show the version number of @command{objcopy}.
2004 Verbose output: list all object files modified. In the case of
2005 archives, @samp{objcopy -V} lists all members of the archive.
2008 Show a summary of the options to @command{objcopy}.
2011 Display a list showing all architectures and object formats available.
2017 @c man begin SEEALSO objcopy
2018 ld(1), objdump(1), and the Info entries for @file{binutils}.
2025 @cindex object file information
2028 @c man title objdump display information from object files.
2031 @c man begin SYNOPSIS objdump
2032 objdump [@option{-a}|@option{--archive-headers}]
2033 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2034 [@option{-C}|@option{--demangle}[=@var{style}] ]
2035 [@option{-d}|@option{--disassemble}]
2036 [@option{-D}|@option{--disassemble-all}]
2037 [@option{-z}|@option{--disassemble-zeroes}]
2038 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2039 [@option{-f}|@option{--file-headers}]
2040 [@option{-F}|@option{--file-offsets}]
2041 [@option{--file-start-context}]
2042 [@option{-g}|@option{--debugging}]
2043 [@option{-e}|@option{--debugging-tags}]
2044 [@option{-h}|@option{--section-headers}|@option{--headers}]
2045 [@option{-i}|@option{--info}]
2046 [@option{-j} @var{section}|@option{--section=}@var{section}]
2047 [@option{-l}|@option{--line-numbers}]
2048 [@option{-S}|@option{--source}]
2049 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2050 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2051 [@option{-p}|@option{--private-headers}]
2052 [@option{-P} @var{options}|@option{--private=}@var{options}]
2053 [@option{-r}|@option{--reloc}]
2054 [@option{-R}|@option{--dynamic-reloc}]
2055 [@option{-s}|@option{--full-contents}]
2056 [@option{-W[lLiaprmfFsoRt]}|
2057 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames]
2058 [=aranges,=macro,=frames,=frames-interp,=str,=loc]
2059 [=Ranges,=pubtypes,=trace_info,=trace_abbrev]
2060 [=trace_aranges,=gdb_index]
2061 [@option{-G}|@option{--stabs}]
2062 [@option{-t}|@option{--syms}]
2063 [@option{-T}|@option{--dynamic-syms}]
2064 [@option{-x}|@option{--all-headers}]
2065 [@option{-w}|@option{--wide}]
2066 [@option{--start-address=}@var{address}]
2067 [@option{--stop-address=}@var{address}]
2068 [@option{--prefix-addresses}]
2069 [@option{--[no-]show-raw-insn}]
2070 [@option{--adjust-vma=}@var{offset}]
2071 [@option{--dwarf-depth=@var{n}}]
2072 [@option{--dwarf-start=@var{n}}]
2073 [@option{--special-syms}]
2074 [@option{--prefix=}@var{prefix}]
2075 [@option{--prefix-strip=}@var{level}]
2076 [@option{--insn-width=}@var{width}]
2077 [@option{-V}|@option{--version}]
2078 [@option{-H}|@option{--help}]
2079 @var{objfile}@dots{}
2083 @c man begin DESCRIPTION objdump
2085 @command{objdump} displays information about one or more object files.
2086 The options control what particular information to display. This
2087 information is mostly useful to programmers who are working on the
2088 compilation tools, as opposed to programmers who just want their
2089 program to compile and work.
2091 @var{objfile}@dots{} are the object files to be examined. When you
2092 specify archives, @command{objdump} shows information on each of the member
2097 @c man begin OPTIONS objdump
2099 The long and short forms of options, shown here as alternatives, are
2100 equivalent. At least one option from the list
2101 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2105 @itemx --archive-header
2106 @cindex archive headers
2107 If any of the @var{objfile} files are archives, display the archive
2108 header information (in a format similar to @samp{ls -l}). Besides the
2109 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2110 the object file format of each archive member.
2112 @item --adjust-vma=@var{offset}
2113 @cindex section addresses in objdump
2114 @cindex VMA in objdump
2115 When dumping information, first add @var{offset} to all the section
2116 addresses. This is useful if the section addresses do not correspond to
2117 the symbol table, which can happen when putting sections at particular
2118 addresses when using a format which can not represent section addresses,
2121 @item -b @var{bfdname}
2122 @itemx --target=@var{bfdname}
2123 @cindex object code format
2124 Specify that the object-code format for the object files is
2125 @var{bfdname}. This option may not be necessary; @var{objdump} can
2126 automatically recognize many formats.
2130 objdump -b oasys -m vax -h fu.o
2133 displays summary information from the section headers (@option{-h}) of
2134 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2135 file in the format produced by Oasys compilers. You can list the
2136 formats available with the @option{-i} option.
2137 @xref{Target Selection}, for more information.
2140 @itemx --demangle[=@var{style}]
2141 @cindex demangling in objdump
2142 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2143 Besides removing any initial underscore prepended by the system, this
2144 makes C++ function names readable. Different compilers have different
2145 mangling styles. The optional demangling style argument can be used to
2146 choose an appropriate demangling style for your compiler. @xref{c++filt},
2147 for more information on demangling.
2151 Display debugging information. This attempts to parse STABS and IEEE
2152 debugging format information stored in the file and print it out using
2153 a C like syntax. If neither of these formats are found this option
2154 falls back on the @option{-W} option to print any DWARF information in
2158 @itemx --debugging-tags
2159 Like @option{-g}, but the information is generated in a format compatible
2163 @itemx --disassemble
2164 @cindex disassembling object code
2165 @cindex machine instructions
2166 Display the assembler mnemonics for the machine instructions from
2167 @var{objfile}. This option only disassembles those sections which are
2168 expected to contain instructions.
2171 @itemx --disassemble-all
2172 Like @option{-d}, but disassemble the contents of all sections, not just
2173 those expected to contain instructions.
2175 This option also has a subtle effect on the disassembly of
2176 instructions in code sections. When option @option{-d} is in effect
2177 objdump will assume that any symbols present in a code section occur
2178 on the boundary between instructions and it will refuse to disassemble
2179 across such a boundary. When option @option{-D} is in effect however
2180 this assumption is supressed. This means that it is possible for the
2181 output of @option{-d} and @option{-D} to differ if, for example, data
2182 is stored in code sections.
2184 If the target is an ARM architecture this switch also has the effect
2185 of forcing the disassembler to decode pieces of data found in code
2186 sections as if they were instructions.
2188 @item --prefix-addresses
2189 When disassembling, print the complete address on each line. This is
2190 the older disassembly format.
2194 @itemx --endian=@{big|little@}
2196 @cindex disassembly endianness
2197 Specify the endianness of the object files. This only affects
2198 disassembly. This can be useful when disassembling a file format which
2199 does not describe endianness information, such as S-records.
2202 @itemx --file-headers
2203 @cindex object file header
2204 Display summary information from the overall header of
2205 each of the @var{objfile} files.
2208 @itemx --file-offsets
2209 @cindex object file offsets
2210 When disassembling sections, whenever a symbol is displayed, also
2211 display the file offset of the region of data that is about to be
2212 dumped. If zeroes are being skipped, then when disassembly resumes,
2213 tell the user how many zeroes were skipped and the file offset of the
2214 location from where the disassembly resumes. When dumping sections,
2215 display the file offset of the location from where the dump starts.
2217 @item --file-start-context
2218 @cindex source code context
2219 Specify that when displaying interlisted source code/disassembly
2220 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2221 context to the start of the file.
2224 @itemx --section-headers
2226 @cindex section headers
2227 Display summary information from the section headers of the
2230 File segments may be relocated to nonstandard addresses, for example by
2231 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2232 @command{ld}. However, some object file formats, such as a.out, do not
2233 store the starting address of the file segments. In those situations,
2234 although @command{ld} relocates the sections correctly, using @samp{objdump
2235 -h} to list the file section headers cannot show the correct addresses.
2236 Instead, it shows the usual addresses, which are implicit for the
2239 Note, in some cases it is possible for a section to have both the
2240 READONLY and the NOREAD attributes set. In such cases the NOREAD
2241 attribute takes precedence, but @command{objdump} will report both
2242 since the exact setting of the flag bits might be important.
2246 Print a summary of the options to @command{objdump} and exit.
2250 @cindex architectures available
2251 @cindex object formats available
2252 Display a list showing all architectures and object formats available
2253 for specification with @option{-b} or @option{-m}.
2256 @itemx --section=@var{name}
2257 @cindex section information
2258 Display information only for section @var{name}.
2261 @itemx --line-numbers
2262 @cindex source filenames for object files
2263 Label the display (using debugging information) with the filename and
2264 source line numbers corresponding to the object code or relocs shown.
2265 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2267 @item -m @var{machine}
2268 @itemx --architecture=@var{machine}
2269 @cindex architecture
2270 @cindex disassembly architecture
2271 Specify the architecture to use when disassembling object files. This
2272 can be useful when disassembling object files which do not describe
2273 architecture information, such as S-records. You can list the available
2274 architectures with the @option{-i} option.
2276 If the target is an ARM architecture then this switch has an
2277 additional effect. It restricts the disassembly to only those
2278 instructions supported by the architecture specified by @var{machine}.
2279 If it is necessary to use this switch because the input file does not
2280 contain any architecture information, but it is also desired to
2281 disassemble all the instructions use @option{-marm}.
2283 @item -M @var{options}
2284 @itemx --disassembler-options=@var{options}
2285 Pass target specific information to the disassembler. Only supported on
2286 some targets. If it is necessary to specify more than one
2287 disassembler option then multiple @option{-M} options can be used or
2288 can be placed together into a comma separated list.
2290 For ARC, @option{dsp} controls the printing of DSP instructions,
2291 @option{spfp} selects the printing of FPX single precision FP
2292 instructions, @option{dpfp} selects the printing of FPX double
2293 precision FP instructions, @option{quarkse_em} selects the printing of
2294 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2295 of double precision assist instructions, @option{fpus} selects the
2296 printing of FPU single precision FP instructions, while @option{fpud}
2297 selects the printing of FPU souble precision FP instructions.
2299 If the target is an ARM architecture then this switch can be used to
2300 select which register name set is used during disassembler. Specifying
2301 @option{-M reg-names-std} (the default) will select the register names as
2302 used in ARM's instruction set documentation, but with register 13 called
2303 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2304 @option{-M reg-names-apcs} will select the name set used by the ARM
2305 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2306 just use @samp{r} followed by the register number.
2308 There are also two variants on the APCS register naming scheme enabled
2309 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2310 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2311 with the normal register names or the special register names).
2313 This option can also be used for ARM architectures to force the
2314 disassembler to interpret all instructions as Thumb instructions by
2315 using the switch @option{--disassembler-options=force-thumb}. This can be
2316 useful when attempting to disassemble thumb code produced by other
2319 For the x86, some of the options duplicate functions of the @option{-m}
2320 switch, but allow finer grained control. Multiple selections from the
2321 following may be specified as a comma separated string.
2326 Select disassembly for the given architecture.
2330 Select between intel syntax mode and AT&T syntax mode.
2334 Select between AMD64 ISA and Intel64 ISA.
2336 @item intel-mnemonic
2338 Select between intel mnemonic mode and AT&T mnemonic mode.
2339 Note: @code{intel-mnemonic} implies @code{intel} and
2340 @code{att-mnemonic} implies @code{att}.
2347 Specify the default address size and operand size. These four options
2348 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2349 appear later in the option string.
2352 When in AT&T mode, instructs the disassembler to print a mnemonic
2353 suffix even when the suffix could be inferred by the operands.
2356 For PowerPC, @option{booke} controls the disassembly of BookE
2357 instructions. @option{32} and @option{64} select PowerPC and
2358 PowerPC64 disassembly, respectively. @option{e300} selects
2359 disassembly for the e300 family. @option{440} selects disassembly for
2360 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2361 single instructions of the PPC750CL.
2363 For MIPS, this option controls the printing of instruction mnemonic
2364 names and register names in disassembled instructions. Multiple
2365 selections from the following may be specified as a comma separated
2366 string, and invalid options are ignored:
2370 Print the 'raw' instruction mnemonic instead of some pseudo
2371 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2372 'sll' instead of 'nop', etc.
2375 Disassemble MSA instructions.
2378 Disassemble the virtualization ASE instructions.
2381 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2383 @item gpr-names=@var{ABI}
2384 Print GPR (general-purpose register) names as appropriate
2385 for the specified ABI. By default, GPR names are selected according to
2386 the ABI of the binary being disassembled.
2388 @item fpr-names=@var{ABI}
2389 Print FPR (floating-point register) names as
2390 appropriate for the specified ABI. By default, FPR numbers are printed
2393 @item cp0-names=@var{ARCH}
2394 Print CP0 (system control coprocessor; coprocessor 0) register names
2395 as appropriate for the CPU or architecture specified by
2396 @var{ARCH}. By default, CP0 register names are selected according to
2397 the architecture and CPU of the binary being disassembled.
2399 @item hwr-names=@var{ARCH}
2400 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2401 as appropriate for the CPU or architecture specified by
2402 @var{ARCH}. By default, HWR names are selected according to
2403 the architecture and CPU of the binary being disassembled.
2405 @item reg-names=@var{ABI}
2406 Print GPR and FPR names as appropriate for the selected ABI.
2408 @item reg-names=@var{ARCH}
2409 Print CPU-specific register names (CP0 register and HWR names)
2410 as appropriate for the selected CPU or architecture.
2413 For any of the options listed above, @var{ABI} or
2414 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2415 rather than names, for the selected types of registers.
2416 You can list the available values of @var{ABI} and @var{ARCH} using
2417 the @option{--help} option.
2419 For VAX, you can specify function entry addresses with @option{-M
2420 entry:0xf00ba}. You can use this multiple times to properly
2421 disassemble VAX binary files that don't contain symbol tables (like
2422 ROM dumps). In these cases, the function entry mask would otherwise
2423 be decoded as VAX instructions, which would probably lead the rest
2424 of the function being wrongly disassembled.
2427 @itemx --private-headers
2428 Print information that is specific to the object file format. The exact
2429 information printed depends upon the object file format. For some
2430 object file formats, no additional information is printed.
2432 @item -P @var{options}
2433 @itemx --private=@var{options}
2434 Print information that is specific to the object file format. The
2435 argument @var{options} is a comma separated list that depends on the
2436 format (the lists of options is displayed with the help).
2438 For XCOFF, the available options are:
2454 Not all object formats support this option. In particular the ELF
2455 format does not use it.
2459 @cindex relocation entries, in object file
2460 Print the relocation entries of the file. If used with @option{-d} or
2461 @option{-D}, the relocations are printed interspersed with the
2465 @itemx --dynamic-reloc
2466 @cindex dynamic relocation entries, in object file
2467 Print the dynamic relocation entries of the file. This is only
2468 meaningful for dynamic objects, such as certain types of shared
2469 libraries. As for @option{-r}, if used with @option{-d} or
2470 @option{-D}, the relocations are printed interspersed with the
2474 @itemx --full-contents
2475 @cindex sections, full contents
2476 @cindex object file sections
2477 Display the full contents of any sections requested. By default all
2478 non-empty sections are displayed.
2482 @cindex source disassembly
2483 @cindex disassembly, with source
2484 Display source code intermixed with disassembly, if possible. Implies
2487 @item --prefix=@var{prefix}
2488 @cindex Add prefix to absolute paths
2489 Specify @var{prefix} to add to the absolute paths when used with
2492 @item --prefix-strip=@var{level}
2493 @cindex Strip absolute paths
2494 Indicate how many initial directory names to strip off the hardwired
2495 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2497 @item --show-raw-insn
2498 When disassembling instructions, print the instruction in hex as well as
2499 in symbolic form. This is the default except when
2500 @option{--prefix-addresses} is used.
2502 @item --no-show-raw-insn
2503 When disassembling instructions, do not print the instruction bytes.
2504 This is the default when @option{--prefix-addresses} is used.
2506 @item --insn-width=@var{width}
2507 @cindex Instruction width
2508 Display @var{width} bytes on a single line when disassembling
2511 @item -W[lLiaprmfFsoRt]
2512 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames]
2513 @itemx --dwarf[=aranges,=macro,=frames,=frames-interp,=str,=loc]
2514 @itemx --dwarf[=Ranges,=pubtypes,=trace_info,=trace_abbrev]
2515 @itemx --dwarf[=trace_aranges,=gdb_index]
2517 @cindex debug symbols
2518 Displays the contents of the debug sections in the file, if any are
2519 present. If one of the optional letters or words follows the switch
2520 then only data found in those specific sections will be dumped.
2522 Note that there is no single letter option to display the content of
2523 trace sections or .gdb_index.
2525 Note: the output from the @option{=info} option can also be affected
2526 by the options @option{--dwarf-depth}, the @option{--dwarf-start} and
2527 the @option{--dwarf-check}.
2529 @item --dwarf-depth=@var{n}
2530 Limit the dump of the @code{.debug_info} section to @var{n} children.
2531 This is only useful with @option{--dwarf=info}. The default is
2532 to print all DIEs; the special value 0 for @var{n} will also have this
2535 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2536 levels will not be printed. The range for @var{n} is zero-based.
2538 @item --dwarf-start=@var{n}
2539 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2540 useful with @option{--dwarf=info}.
2542 If specified, this option will suppress printing of any header
2543 information and all DIEs before the DIE numbered @var{n}. Only
2544 siblings and children of the specified DIE will be printed.
2546 This can be used in conjunction with @option{--dwarf-depth}.
2549 Enable additional checks for consistency of Dwarf information.
2555 @cindex debug symbols
2556 @cindex ELF object file format
2557 Display the full contents of any sections requested. Display the
2558 contents of the .stab and .stab.index and .stab.excl sections from an
2559 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2560 @code{.stab} debugging symbol-table entries are carried in an ELF
2561 section. In most other file formats, debugging symbol-table entries are
2562 interleaved with linkage symbols, and are visible in the @option{--syms}
2565 @item --start-address=@var{address}
2566 @cindex start-address
2567 Start displaying data at the specified address. This affects the output
2568 of the @option{-d}, @option{-r} and @option{-s} options.
2570 @item --stop-address=@var{address}
2571 @cindex stop-address
2572 Stop displaying data at the specified address. This affects the output
2573 of the @option{-d}, @option{-r} and @option{-s} options.
2577 @cindex symbol table entries, printing
2578 Print the symbol table entries of the file.
2579 This is similar to the information provided by the @samp{nm} program,
2580 although the display format is different. The format of the output
2581 depends upon the format of the file being dumped, but there are two main
2582 types. One looks like this:
2585 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2586 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2589 where the number inside the square brackets is the number of the entry
2590 in the symbol table, the @var{sec} number is the section number, the
2591 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2592 symbol's type, the @var{scl} number is the symbol's storage class and
2593 the @var{nx} value is the number of auxilary entries associated with
2594 the symbol. The last two fields are the symbol's value and its name.
2596 The other common output format, usually seen with ELF based files,
2600 00000000 l d .bss 00000000 .bss
2601 00000000 g .text 00000000 fred
2604 Here the first number is the symbol's value (sometimes refered to as
2605 its address). The next field is actually a set of characters and
2606 spaces indicating the flag bits that are set on the symbol. These
2607 characters are described below. Next is the section with which the
2608 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2609 not connected with any section), or @emph{*UND*} if the section is
2610 referenced in the file being dumped, but not defined there.
2612 After the section name comes another field, a number, which for common
2613 symbols is the alignment and for other symbol is the size. Finally
2614 the symbol's name is displayed.
2616 The flag characters are divided into 7 groups as follows:
2622 The symbol is a local (l), global (g), unique global (u), neither
2623 global nor local (a space) or both global and local (!). A
2624 symbol can be neither local or global for a variety of reasons, e.g.,
2625 because it is used for debugging, but it is probably an indication of
2626 a bug if it is ever both local and global. Unique global symbols are
2627 a GNU extension to the standard set of ELF symbol bindings. For such
2628 a symbol the dynamic linker will make sure that in the entire process
2629 there is just one symbol with this name and type in use.
2632 The symbol is weak (w) or strong (a space).
2635 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2638 The symbol is a warning (W) or a normal symbol (a space). A warning
2639 symbol's name is a message to be displayed if the symbol following the
2640 warning symbol is ever referenced.
2644 The symbol is an indirect reference to another symbol (I), a function
2645 to be evaluated during reloc processing (i) or a normal symbol (a
2650 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2651 normal symbol (a space).
2656 The symbol is the name of a function (F) or a file (f) or an object
2657 (O) or just a normal symbol (a space).
2661 @itemx --dynamic-syms
2662 @cindex dynamic symbol table entries, printing
2663 Print the dynamic symbol table entries of the file. This is only
2664 meaningful for dynamic objects, such as certain types of shared
2665 libraries. This is similar to the information provided by the @samp{nm}
2666 program when given the @option{-D} (@option{--dynamic}) option.
2668 The output format is similar to that produced by the @option{--syms}
2669 option, except that an extra field is inserted before the symbol's
2670 name, giving the version information associated with the symbol.
2671 If the version is the default version to be used when resolving
2672 unversioned references to the symbol then it's displayed as is,
2673 otherwise it's put into parentheses.
2675 @item --special-syms
2676 When displaying symbols include those which the target considers to be
2677 special in some way and which would not normally be of interest to the
2682 Print the version number of @command{objdump} and exit.
2685 @itemx --all-headers
2686 @cindex all header information, object file
2687 @cindex header information, all
2688 Display all available header information, including the symbol table and
2689 relocation entries. Using @option{-x} is equivalent to specifying all of
2690 @option{-a -f -h -p -r -t}.
2694 @cindex wide output, printing
2695 Format some lines for output devices that have more than 80 columns.
2696 Also do not truncate symbol names when they are displayed.
2699 @itemx --disassemble-zeroes
2700 Normally the disassembly output will skip blocks of zeroes. This
2701 option directs the disassembler to disassemble those blocks, just like
2708 @c man begin SEEALSO objdump
2709 nm(1), readelf(1), and the Info entries for @file{binutils}.
2717 @cindex archive contents
2718 @cindex symbol index
2720 @c man title ranlib generate index to archive.
2723 @c man begin SYNOPSIS ranlib
2724 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2728 @c man begin DESCRIPTION ranlib
2730 @command{ranlib} generates an index to the contents of an archive and
2731 stores it in the archive. The index lists each symbol defined by a
2732 member of an archive that is a relocatable object file.
2734 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2736 An archive with such an index speeds up linking to the library and
2737 allows routines in the library to call each other without regard to
2738 their placement in the archive.
2740 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2741 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2746 @c man begin OPTIONS ranlib
2752 Show usage information for @command{ranlib}.
2757 Show the version number of @command{ranlib}.
2760 @cindex deterministic archives
2761 @kindex --enable-deterministic-archives
2762 Operate in @emph{deterministic} mode. The symbol map archive member's
2763 header will show zero for the UID, GID, and timestamp. When this
2764 option is used, multiple runs will produce identical output files.
2766 If @file{binutils} was configured with
2767 @option{--enable-deterministic-archives}, then this mode is on by
2768 default. It can be disabled with the @samp{-U} option, described
2772 Update the timestamp of the symbol map of an archive.
2775 @cindex deterministic archives
2776 @kindex --enable-deterministic-archives
2777 Do @emph{not} operate in @emph{deterministic} mode. This is the
2778 inverse of the @samp{-D} option, above: the archive index will get
2779 actual UID, GID, timestamp, and file mode values.
2781 If @file{binutils} was configured @emph{without}
2782 @option{--enable-deterministic-archives}, then this mode is on by
2790 @c man begin SEEALSO ranlib
2791 ar(1), nm(1), and the Info entries for @file{binutils}.
2799 @cindex section sizes
2801 @c man title size list section sizes and total size.
2804 @c man begin SYNOPSIS size
2805 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2807 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2809 [@option{-t}|@option{--totals}]
2810 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2811 [@var{objfile}@dots{}]
2815 @c man begin DESCRIPTION size
2817 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2818 size---for each of the object or archive files @var{objfile} in its
2819 argument list. By default, one line of output is generated for each
2820 object file or each module in an archive.
2822 @var{objfile}@dots{} are the object files to be examined.
2823 If none are specified, the file @code{a.out} will be used.
2827 @c man begin OPTIONS size
2829 The command line options have the following meanings:
2834 @itemx --format=@var{compatibility}
2835 @cindex @command{size} display format
2836 Using one of these options, you can choose whether the output from @sc{gnu}
2837 @command{size} resembles output from System V @command{size} (using @option{-A},
2838 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2839 @option{--format=berkeley}). The default is the one-line format similar to
2841 @c Bonus for doc-source readers: you can also say --format=strange (or
2842 @c anything else that starts with 's') for sysv, and --format=boring (or
2843 @c anything else that starts with 'b') for Berkeley.
2845 Here is an example of the Berkeley (default) format of output from
2848 $ size --format=Berkeley ranlib size
2849 text data bss dec hex filename
2850 294880 81920 11592 388392 5ed28 ranlib
2851 294880 81920 11888 388688 5ee50 size
2855 This is the same data, but displayed closer to System V conventions:
2858 $ size --format=SysV ranlib size
2876 Show a summary of acceptable arguments and options.
2881 @itemx --radix=@var{number}
2882 @cindex @command{size} number format
2883 @cindex radix for section sizes
2884 Using one of these options, you can control whether the size of each
2885 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2886 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2887 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2888 values (8, 10, 16) are supported. The total size is always given in two
2889 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2890 octal and hexadecimal if you're using @option{-o}.
2893 Print total size of common symbols in each file. When using Berkeley
2894 format these are included in the bss size.
2898 Show totals of all objects listed (Berkeley format listing mode only).
2900 @item --target=@var{bfdname}
2901 @cindex object code format
2902 Specify that the object-code format for @var{objfile} is
2903 @var{bfdname}. This option may not be necessary; @command{size} can
2904 automatically recognize many formats.
2905 @xref{Target Selection}, for more information.
2909 Display the version number of @command{size}.
2915 @c man begin SEEALSO size
2916 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2923 @cindex listings strings
2924 @cindex printing strings
2925 @cindex strings, printing
2927 @c man title strings print the strings of printable characters in files.
2930 @c man begin SYNOPSIS strings
2931 strings [@option{-afovV}] [@option{-}@var{min-len}]
2932 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2933 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2934 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2935 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2936 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2937 [@option{-w}] [@option{--include-all-whitespace}]
2938 [@option{-s}] [@option{--output-separator}@var{sep_string}]
2939 [@option{--help}] [@option{--version}] @var{file}@dots{}
2943 @c man begin DESCRIPTION strings
2945 For each @var{file} given, @sc{gnu} @command{strings} prints the
2946 printable character sequences that are at least 4 characters long (or
2947 the number given with the options below) and are followed by an
2948 unprintable character.
2950 Depending upon how the strings program was configured it will default
2951 to either displaying all the printable sequences that it can find in
2952 each file, or only those sequences that are in loadable, initialized
2953 data sections. If the file type in unrecognizable, or if strings is
2954 reading from stdin then it will always display all of the printable
2955 sequences that it can find.
2957 For backwards compatibility any file that occurs after a command line
2958 option of just @option{-} will also be scanned in full, regardless of
2959 the presence of any @option{-d} option.
2961 @command{strings} is mainly useful for determining the contents of
2966 @c man begin OPTIONS strings
2972 Scan the whole file, regardless of what sections it contains or
2973 whether those sections are loaded or initialized. Normally this is
2974 the default behaviour, but strings can be configured so that the
2975 @option{-d} is the default instead.
2977 The @option{-} option is position dependent and forces strings to
2978 perform full scans of any file that is mentioned after the @option{-}
2979 on the command line, even if the @option{-d} option has been
2984 Only print strings from initialized, loaded data sections in the
2985 file. This may reduce the amount of garbage in the output, but it
2986 also exposes the strings program to any security flaws that may be
2987 present in the BFD library used to scan and load sections. Strings
2988 can be configured so that this option is the default behaviour. In
2989 such cases the @option{-a} option can be used to avoid using the BFD
2990 library and instead just print all of the strings found in the file.
2993 @itemx --print-file-name
2994 Print the name of the file before each string.
2997 Print a summary of the program usage on the standard output and exit.
2999 @item -@var{min-len}
3000 @itemx -n @var{min-len}
3001 @itemx --bytes=@var{min-len}
3002 Print sequences of characters that are at least @var{min-len} characters
3003 long, instead of the default 4.
3006 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3007 act like @samp{-t d} instead. Since we can not be compatible with both
3008 ways, we simply chose one.
3010 @item -t @var{radix}
3011 @itemx --radix=@var{radix}
3012 Print the offset within the file before each string. The single
3013 character argument specifies the radix of the offset---@samp{o} for
3014 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3016 @item -e @var{encoding}
3017 @itemx --encoding=@var{encoding}
3018 Select the character encoding of the strings that are to be found.
3019 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3020 characters (ASCII, ISO 8859, etc., default), @samp{S} =
3021 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3022 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3023 littleendian. Useful for finding wide character strings. (@samp{l}
3024 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3026 @item -T @var{bfdname}
3027 @itemx --target=@var{bfdname}
3028 @cindex object code format
3029 Specify an object code format other than your system's default format.
3030 @xref{Target Selection}, for more information.
3035 Print the program version number on the standard output and exit.
3038 @itemx --include-all-whitespace
3039 By default tab and space characters are included in the strings that
3040 are displayed, but other whitespace characters, such a newlines and
3041 carriage returns, are not. The @option{-w} option changes this so
3042 that all whitespace characters are considered to be part of a string.
3045 @itemx --output-separator
3046 By default, output strings are delimited by a new-line. This option
3047 allows you to supply any string to be used as the output record
3048 separator. Useful with --include-all-whitespace where strings
3049 may contain new-lines internally.
3055 @c man begin SEEALSO strings
3056 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3057 and the Info entries for @file{binutils}.
3065 @cindex removing symbols
3066 @cindex discarding symbols
3067 @cindex symbols, discarding
3069 @c man title strip Discard symbols from object files.
3072 @c man begin SYNOPSIS strip
3073 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3074 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3075 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3076 [@option{-s}|@option{--strip-all}]
3077 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3078 [@option{--strip-dwo}]
3079 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
3080 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3081 [@option{-w}|@option{--wildcard}]
3082 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3083 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3084 [@option{--remove-relocations=}@var{sectionpattern}]
3085 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3086 [@option{-D}|@option{--enable-deterministic-archives}]
3087 [@option{-U}|@option{--disable-deterministic-archives}]
3088 [@option{--keep-file-symbols}]
3089 [@option{--only-keep-debug}]
3090 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3091 [@option{--help}] [@option{--info}]
3092 @var{objfile}@dots{}
3096 @c man begin DESCRIPTION strip
3098 @sc{gnu} @command{strip} discards all symbols from object files
3099 @var{objfile}. The list of object files may include archives.
3100 At least one object file must be given.
3102 @command{strip} modifies the files named in its argument,
3103 rather than writing modified copies under different names.
3107 @c man begin OPTIONS strip
3110 @item -F @var{bfdname}
3111 @itemx --target=@var{bfdname}
3112 Treat the original @var{objfile} as a file with the object
3113 code format @var{bfdname}, and rewrite it in the same format.
3114 @xref{Target Selection}, for more information.
3117 Show a summary of the options to @command{strip} and exit.
3120 Display a list showing all architectures and object formats available.
3122 @item -I @var{bfdname}
3123 @itemx --input-target=@var{bfdname}
3124 Treat the original @var{objfile} as a file with the object
3125 code format @var{bfdname}.
3126 @xref{Target Selection}, for more information.
3128 @item -O @var{bfdname}
3129 @itemx --output-target=@var{bfdname}
3130 Replace @var{objfile} with a file in the output format @var{bfdname}.
3131 @xref{Target Selection}, for more information.
3133 @item -R @var{sectionname}
3134 @itemx --remove-section=@var{sectionname}
3135 Remove any section named @var{sectionname} from the output file, in
3136 addition to whatever sections would otherwise be removed. This
3137 option may be given more than once. Note that using this option
3138 inappropriately may make the output file unusable. The wildcard
3139 character @samp{*} may be given at the end of @var{sectionname}. If
3140 so, then any section starting with @var{sectionname} will be removed.
3142 If the first character of @var{sectionpattern} is the exclamation
3143 point (!) then matching sections will not be removed even if an
3144 earlier use of @option{--remove-section} on the same command line
3145 would otherwise remove it. For example:
3148 --remove-section=.text.* --remove-section=!.text.foo
3151 will remove all sections matching the pattern '.text.*', but will not
3152 remove the section '.text.foo'.
3154 @item --remove-relocations=@var{sectionpattern}
3155 Remove relocations from the output file for any section matching
3156 @var{sectionpattern}. This option may be given more than once. Note
3157 that using this option inappropriately may make the output file
3158 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3162 --remove-relocations=.text.*
3165 will remove the relocations for all sections matching the patter
3168 If the first character of @var{sectionpattern} is the exclamation
3169 point (!) then matching sections will not have their relocation
3170 removed even if an earlier use of @option{--remove-relocations} on the
3171 same command line would otherwise cause the relocations to be removed.
3175 --remove-relocations=.text.* --remove-relocations=!.text.foo
3178 will remove all relocations for sections matching the pattern
3179 '.text.*', but will not remove relocations for the section
3189 @itemx --strip-debug
3190 Remove debugging symbols only.
3193 Remove the contents of all DWARF .dwo sections, leaving the
3194 remaining debugging sections and all symbols intact.
3195 See the description of this option in the @command{objcopy} section
3196 for more information.
3198 @item --strip-unneeded
3199 Remove all symbols that are not needed for relocation processing.
3201 @item -K @var{symbolname}
3202 @itemx --keep-symbol=@var{symbolname}
3203 When stripping symbols, keep symbol @var{symbolname} even if it would
3204 normally be stripped. This option may be given more than once.
3206 @item -N @var{symbolname}
3207 @itemx --strip-symbol=@var{symbolname}
3208 Remove symbol @var{symbolname} from the source file. This option may be
3209 given more than once, and may be combined with strip options other than
3213 Put the stripped output in @var{file}, rather than replacing the
3214 existing file. When this argument is used, only one @var{objfile}
3215 argument may be specified.
3218 @itemx --preserve-dates
3219 Preserve the access and modification dates of the file.
3222 @itemx --enable-deterministic-archives
3223 @cindex deterministic archives
3224 @kindex --enable-deterministic-archives
3225 Operate in @emph{deterministic} mode. When copying archive members
3226 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3227 and use consistent file modes for all files.
3229 If @file{binutils} was configured with
3230 @option{--enable-deterministic-archives}, then this mode is on by default.
3231 It can be disabled with the @samp{-U} option, below.
3234 @itemx --disable-deterministic-archives
3235 @cindex deterministic archives
3236 @kindex --enable-deterministic-archives
3237 Do @emph{not} operate in @emph{deterministic} mode. This is the
3238 inverse of the @option{-D} option, above: when copying archive members
3239 and writing the archive index, use their actual UID, GID, timestamp,
3240 and file mode values.
3242 This is the default unless @file{binutils} was configured with
3243 @option{--enable-deterministic-archives}.
3247 Permit regular expressions in @var{symbolname}s used in other command
3248 line options. The question mark (?), asterisk (*), backslash (\) and
3249 square brackets ([]) operators can be used anywhere in the symbol
3250 name. If the first character of the symbol name is the exclamation
3251 point (!) then the sense of the switch is reversed for that symbol.
3258 would cause strip to only keep symbols that start with the letters
3259 ``fo'', but to discard the symbol ``foo''.
3262 @itemx --discard-all
3263 Remove non-global symbols.
3266 @itemx --discard-locals
3267 Remove compiler-generated local symbols.
3268 (These usually start with @samp{L} or @samp{.}.)
3270 @item --keep-file-symbols
3271 When stripping a file, perhaps with @option{--strip-debug} or
3272 @option{--strip-unneeded}, retain any symbols specifying source file names,
3273 which would otherwise get stripped.
3275 @item --only-keep-debug
3276 Strip a file, emptying the contents of any sections that would not be
3277 stripped by @option{--strip-debug} and leaving the debugging sections
3278 intact. In ELF files, this preserves all the note sections in the
3281 Note - the section headers of the stripped sections are preserved,
3282 including their sizes, but the contents of the section are discarded.
3283 The section headers are preserved so that other tools can match up the
3284 debuginfo file with the real executable, even if that executable has
3285 been relocated to a different address space.
3287 The intention is that this option will be used in conjunction with
3288 @option{--add-gnu-debuglink} to create a two part executable. One a
3289 stripped binary which will occupy less space in RAM and in a
3290 distribution and the second a debugging information file which is only
3291 needed if debugging abilities are required. The suggested procedure
3292 to create these files is as follows:
3295 @item Link the executable as normal. Assuming that is is called
3297 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3298 create a file containing the debugging info.
3299 @item Run @code{objcopy --strip-debug foo} to create a
3300 stripped executable.
3301 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3302 to add a link to the debugging info into the stripped executable.
3305 Note---the choice of @code{.dbg} as an extension for the debug info
3306 file is arbitrary. Also the @code{--only-keep-debug} step is
3307 optional. You could instead do this:
3310 @item Link the executable as normal.
3311 @item Copy @code{foo} to @code{foo.full}
3312 @item Run @code{strip --strip-debug foo}
3313 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3316 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3317 full executable. It does not have to be a file created by the
3318 @option{--only-keep-debug} switch.
3320 Note---this switch is only intended for use on fully linked files. It
3321 does not make sense to use it on object files where the debugging
3322 information may be incomplete. Besides the gnu_debuglink feature
3323 currently only supports the presence of one filename containing
3324 debugging information, not multiple filenames on a one-per-object-file
3329 Show the version number for @command{strip}.
3333 Verbose output: list all object files modified. In the case of
3334 archives, @samp{strip -v} lists all members of the archive.
3340 @c man begin SEEALSO strip
3341 the Info entries for @file{binutils}.
3345 @node c++filt, addr2line, strip, Top
3349 @cindex demangling C++ symbols
3351 @c man title cxxfilt Demangle C++ and Java symbols.
3354 @c man begin SYNOPSIS cxxfilt
3355 c++filt [@option{-_}|@option{--strip-underscore}]
3356 [@option{-n}|@option{--no-strip-underscore}]
3357 [@option{-p}|@option{--no-params}]
3358 [@option{-t}|@option{--types}]
3359 [@option{-i}|@option{--no-verbose}]
3360 [@option{-s} @var{format}|@option{--format=}@var{format}]
3361 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3365 @c man begin DESCRIPTION cxxfilt
3368 The C++ and Java languages provide function overloading, which means
3369 that you can write many functions with the same name, providing that
3370 each function takes parameters of different types. In order to be
3371 able to distinguish these similarly named functions C++ and Java
3372 encode them into a low-level assembler name which uniquely identifies
3373 each different version. This process is known as @dfn{mangling}. The
3375 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3376 MS-DOS this program is named @command{CXXFILT}.}
3377 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3378 names into user-level names so that they can be read.
3380 Every alphanumeric word (consisting of letters, digits, underscores,
3381 dollars, or periods) seen in the input is a potential mangled name.
3382 If the name decodes into a C++ name, the C++ name replaces the
3383 low-level name in the output, otherwise the original word is output.
3384 In this way you can pass an entire assembler source file, containing
3385 mangled names, through @command{c++filt} and see the same source file
3386 containing demangled names.
3388 You can also use @command{c++filt} to decipher individual symbols by
3389 passing them on the command line:
3392 c++filt @var{symbol}
3395 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3396 names from the standard input instead. All the results are printed on
3397 the standard output. The difference between reading names from the
3398 command line versus reading names from the standard input is that
3399 command line arguments are expected to be just mangled names and no
3400 checking is performed to separate them from surrounding text. Thus
3407 will work and demangle the name to ``f()'' whereas:
3413 will not work. (Note the extra comma at the end of the mangled
3414 name which makes it invalid). This command however will work:
3417 echo _Z1fv, | c++filt -n
3420 and will display ``f(),'', i.e., the demangled name followed by a
3421 trailing comma. This behaviour is because when the names are read
3422 from the standard input it is expected that they might be part of an
3423 assembler source file where there might be extra, extraneous
3424 characters trailing after a mangled name. For example:
3427 .type _Z1fv, @@function
3432 @c man begin OPTIONS cxxfilt
3436 @itemx --strip-underscore
3437 On some systems, both the C and C++ compilers put an underscore in front
3438 of every name. For example, the C name @code{foo} gets the low-level
3439 name @code{_foo}. This option removes the initial underscore. Whether
3440 @command{c++filt} removes the underscore by default is target dependent.
3443 @itemx --no-strip-underscore
3444 Do not remove the initial underscore.
3448 When demangling the name of a function, do not display the types of
3449 the function's parameters.
3453 Attempt to demangle types as well as function names. This is disabled
3454 by default since mangled types are normally only used internally in
3455 the compiler, and they can be confused with non-mangled names. For example,
3456 a function called ``a'' treated as a mangled type name would be
3457 demangled to ``signed char''.
3461 Do not include implementation details (if any) in the demangled
3464 @item -s @var{format}
3465 @itemx --format=@var{format}
3466 @command{c++filt} can decode various methods of mangling, used by
3467 different compilers. The argument to this option selects which
3472 Automatic selection based on executable (the default method)
3474 the one used by the @sc{gnu} C++ compiler (g++)
3476 the one used by the Lucid compiler (lcc)
3478 the one specified by the C++ Annotated Reference Manual
3480 the one used by the HP compiler (aCC)
3482 the one used by the EDG compiler
3484 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3486 the one used by the @sc{gnu} Java compiler (gcj)
3488 the one used by the @sc{gnu} Ada compiler (GNAT).
3492 Print a summary of the options to @command{c++filt} and exit.
3495 Print the version number of @command{c++filt} and exit.
3501 @c man begin SEEALSO cxxfilt
3502 the Info entries for @file{binutils}.
3507 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3508 user interface are subject to change in future releases. In particular,
3509 a command-line option may be required in the future to decode a name
3510 passed as an argument on the command line; in other words,
3513 c++filt @var{symbol}
3517 may in a future release become
3520 c++filt @var{option} @var{symbol}
3528 @cindex address to file name and line number
3530 @c man title addr2line convert addresses into file names and line numbers.
3533 @c man begin SYNOPSIS addr2line
3534 addr2line [@option{-a}|@option{--addresses}]
3535 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3536 [@option{-C}|@option{--demangle}[=@var{style}]]
3537 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3538 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3539 [@option{-i}|@option{--inlines}]
3540 [@option{-p}|@option{--pretty-print}]
3541 [@option{-j}|@option{--section=}@var{name}]
3542 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3547 @c man begin DESCRIPTION addr2line
3549 @command{addr2line} translates addresses into file names and line numbers.
3550 Given an address in an executable or an offset in a section of a relocatable
3551 object, it uses the debugging information to figure out which file name and
3552 line number are associated with it.
3554 The executable or relocatable object to use is specified with the @option{-e}
3555 option. The default is the file @file{a.out}. The section in the relocatable
3556 object to use is specified with the @option{-j} option.
3558 @command{addr2line} has two modes of operation.
3560 In the first, hexadecimal addresses are specified on the command line,
3561 and @command{addr2line} displays the file name and line number for each
3564 In the second, @command{addr2line} reads hexadecimal addresses from
3565 standard input, and prints the file name and line number for each
3566 address on standard output. In this mode, @command{addr2line} may be used
3567 in a pipe to convert dynamically chosen addresses.
3569 The format of the output is @samp{FILENAME:LINENO}. By default
3570 each input address generates one line of output.
3572 Two options can generate additional lines before each
3573 @samp{FILENAME:LINENO} line (in that order).
3575 If the @option{-a} option is used then a line with the input address
3578 If the @option{-f} option is used, then a line with the
3579 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3580 containing the address.
3582 One option can generate additional lines after the
3583 @samp{FILENAME:LINENO} line.
3585 If the @option{-i} option is used and the code at the given address is
3586 present there because of inlining by the compiler then additional
3587 lines are displayed afterwards. One or two extra lines (if the
3588 @option{-f} option is used) are displayed for each inlined function.
3590 Alternatively if the @option{-p} option is used then each input
3591 address generates a single, long, output line containing the address,
3592 the function name, the file name and the line number. If the
3593 @option{-i} option has also been used then any inlined functions will
3594 be displayed in the same manner, but on separate lines, and prefixed
3595 by the text @samp{(inlined by)}.
3597 If the file name or function name can not be determined,
3598 @command{addr2line} will print two question marks in their place. If the
3599 line number can not be determined, @command{addr2line} will print 0.
3603 @c man begin OPTIONS addr2line
3605 The long and short forms of options, shown here as alternatives, are
3611 Display the address before the function name, file and line number
3612 information. The address is printed with a @samp{0x} prefix to easily
3615 @item -b @var{bfdname}
3616 @itemx --target=@var{bfdname}
3617 @cindex object code format
3618 Specify that the object-code format for the object files is
3622 @itemx --demangle[=@var{style}]
3623 @cindex demangling in objdump
3624 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3625 Besides removing any initial underscore prepended by the system, this
3626 makes C++ function names readable. Different compilers have different
3627 mangling styles. The optional demangling style argument can be used to
3628 choose an appropriate demangling style for your compiler. @xref{c++filt},
3629 for more information on demangling.
3631 @item -e @var{filename}
3632 @itemx --exe=@var{filename}
3633 Specify the name of the executable for which addresses should be
3634 translated. The default file is @file{a.out}.
3638 Display function names as well as file and line number information.
3642 Display only the base of each file name.
3646 If the address belongs to a function that was inlined, the source
3647 information for all enclosing scopes back to the first non-inlined
3648 function will also be printed. For example, if @code{main} inlines
3649 @code{callee1} which inlines @code{callee2}, and address is from
3650 @code{callee2}, the source information for @code{callee1} and @code{main}
3651 will also be printed.
3655 Read offsets relative to the specified section instead of absolute addresses.
3658 @itemx --pretty-print
3659 Make the output more human friendly: each location are printed on one line.
3660 If option @option{-i} is specified, lines for all enclosing scopes are
3661 prefixed with @samp{(inlined by)}.
3667 @c man begin SEEALSO addr2line
3668 Info entries for @file{binutils}.
3675 @command{nlmconv} converts a relocatable object file into a NetWare
3679 @command{nlmconv} currently works with @samp{i386} object
3680 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3681 object files in @sc{elf}, or @code{a.out} format@footnote{
3682 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3683 format in the Binary File Descriptor library. It has only been tested
3684 with the above formats.}.
3688 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3689 utilities, since it is only useful for NLM targets.
3692 @c man title nlmconv converts object code into an NLM.
3695 @c man begin SYNOPSIS nlmconv
3696 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3697 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3698 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3699 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3700 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3701 @var{infile} @var{outfile}
3705 @c man begin DESCRIPTION nlmconv
3707 @command{nlmconv} converts the relocatable @samp{i386} object file
3708 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3709 reading @var{headerfile} for NLM header information. For instructions
3710 on writing the NLM command file language used in header files, see the
3711 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3712 Development and Tools Overview}, which is part of the NLM Software
3713 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3714 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3717 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3720 @command{nlmconv} can perform a link step. In other words, you can list
3721 more than one object file for input if you list them in the definitions
3722 file (rather than simply specifying one input file on the command line).
3723 In this case, @command{nlmconv} calls the linker for you.
3727 @c man begin OPTIONS nlmconv
3730 @item -I @var{bfdname}
3731 @itemx --input-target=@var{bfdname}
3732 Object format of the input file. @command{nlmconv} can usually determine
3733 the format of a given file (so no default is necessary).
3734 @xref{Target Selection}, for more information.
3736 @item -O @var{bfdname}
3737 @itemx --output-target=@var{bfdname}
3738 Object format of the output file. @command{nlmconv} infers the output
3739 format based on the input format, e.g. for a @samp{i386} input file the
3740 output format is @samp{nlm32-i386}.
3741 @xref{Target Selection}, for more information.
3743 @item -T @var{headerfile}
3744 @itemx --header-file=@var{headerfile}
3745 Reads @var{headerfile} for NLM header information. For instructions on
3746 writing the NLM command file language used in header files, see@ see the
3747 @samp{linkers} section, of the @cite{NLM Development and Tools
3748 Overview}, which is part of the NLM Software Developer's Kit, available
3753 Displays (on standard error) the linker command line used by @command{nlmconv}.
3755 @item -l @var{linker}
3756 @itemx --linker=@var{linker}
3757 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3762 Prints a usage summary.
3766 Prints the version number for @command{nlmconv}.
3772 @c man begin SEEALSO nlmconv
3773 the Info entries for @file{binutils}.
3780 @command{windmc} may be used to generator Windows message resources.
3783 @emph{Warning:} @command{windmc} is not always built as part of the binary
3784 utilities, since it is only useful for Windows targets.
3787 @c man title windmc generates Windows message resources.
3790 @c man begin SYNOPSIS windmc
3791 windmc [options] input-file
3795 @c man begin DESCRIPTION windmc
3797 @command{windmc} reads message definitions from an input file (.mc) and
3798 translate them into a set of output files. The output files may be of
3803 A C header file containing the message definitions.
3806 A resource file compilable by the @command{windres} tool.
3809 One or more binary files containing the resource data for a specific
3813 A C include file that maps message id's to their symbolic name.
3816 The exact description of these different formats is available in
3817 documentation from Microsoft.
3819 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3820 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3821 Windows Message Compiler.
3825 @c man begin OPTIONS windmc
3830 Specifies that the input file specified is ASCII. This is the default
3835 Specifies that messages in the output @code{bin} files should be in ASCII
3840 Specifies that @code{bin} filenames should have to be prefixed by the
3841 basename of the source file.
3845 Sets the customer bit in all message id's.
3847 @item -C @var{codepage}
3848 @itemx --codepage_in @var{codepage}
3849 Sets the default codepage to be used to convert input file to UTF16. The
3850 default is ocdepage 1252.
3853 @itemx --decimal_values
3854 Outputs the constants in the header file in decimal. Default is using
3858 @itemx --extension @var{ext}
3859 The extension for the header file. The default is .h extension.
3861 @item -F @var{target}
3862 @itemx --target @var{target}
3863 Specify the BFD format to use for a bin file as output. This
3864 is a BFD target name; you can use the @option{--help} option to see a list
3865 of supported targets. Normally @command{windmc} will use the default
3866 format, which is the first one listed by the @option{--help} option.
3868 @ref{Target Selection}.
3872 @itemx --headerdir @var{path}
3873 The target directory of the generated header file. The default is the
3878 Displays a list of command line options and then exits.
3880 @item -m @var{characters}
3881 @itemx --maxlength @var{characters}
3882 Instructs @command{windmc} to generate a warning if the length
3883 of any message exceeds the number specified.
3886 @itemx --nullterminate
3887 Terminate message text in @code{bin} files by zero. By default they are
3888 terminated by CR/LF.
3891 @itemx --hresult_use
3892 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3893 file, using HRESULT definitions. Status codes are used if the flag is not
3896 @item -O @var{codepage}
3897 @itemx --codepage_out @var{codepage}
3898 Sets the default codepage to be used to output text files. The default
3902 @itemx --rcdir @var{path}
3903 The target directory for the generated @code{rc} script and the generated
3904 @code{bin} files that the resource compiler script includes. The default
3905 is the current directory.
3909 Specifies that the input file is UTF16.
3912 @itemx --unicode_out
3913 Specifies that messages in the output @code{bin} file should be in UTF16
3914 format. This is the default behaviour.
3918 Enable verbose mode.
3922 Prints the version number for @command{windmc}.
3925 @itemx --xdgb @var{path}
3926 The path of the @code{dbg} C include file that maps message id's to the
3927 symbolic name. No such file is generated without specifying the switch.
3933 @c man begin SEEALSO windmc
3934 the Info entries for @file{binutils}.
3941 @command{windres} may be used to manipulate Windows resources.
3944 @emph{Warning:} @command{windres} is not always built as part of the binary
3945 utilities, since it is only useful for Windows targets.
3948 @c man title windres manipulate Windows resources.
3951 @c man begin SYNOPSIS windres
3952 windres [options] [input-file] [output-file]
3956 @c man begin DESCRIPTION windres
3958 @command{windres} reads resources from an input file and copies them into
3959 an output file. Either file may be in one of three formats:
3963 A text format read by the Resource Compiler.
3966 A binary format generated by the Resource Compiler.
3969 A COFF object or executable.
3972 The exact description of these different formats is available in
3973 documentation from Microsoft.
3975 When @command{windres} converts from the @code{rc} format to the @code{res}
3976 format, it is acting like the Windows Resource Compiler. When
3977 @command{windres} converts from the @code{res} format to the @code{coff}
3978 format, it is acting like the Windows @code{CVTRES} program.
3980 When @command{windres} generates an @code{rc} file, the output is similar
3981 but not identical to the format expected for the input. When an input
3982 @code{rc} file refers to an external filename, an output @code{rc} file
3983 will instead include the file contents.
3985 If the input or output format is not specified, @command{windres} will
3986 guess based on the file name, or, for the input file, the file contents.
3987 A file with an extension of @file{.rc} will be treated as an @code{rc}
3988 file, a file with an extension of @file{.res} will be treated as a
3989 @code{res} file, and a file with an extension of @file{.o} or
3990 @file{.exe} will be treated as a @code{coff} file.
3992 If no output file is specified, @command{windres} will print the resources
3993 in @code{rc} format to standard output.
3995 The normal use is for you to write an @code{rc} file, use @command{windres}
3996 to convert it to a COFF object file, and then link the COFF file into
3997 your application. This will make the resources described in the
3998 @code{rc} file available to Windows.
4002 @c man begin OPTIONS windres
4005 @item -i @var{filename}
4006 @itemx --input @var{filename}
4007 The name of the input file. If this option is not used, then
4008 @command{windres} will use the first non-option argument as the input file
4009 name. If there are no non-option arguments, then @command{windres} will
4010 read from standard input. @command{windres} can not read a COFF file from
4013 @item -o @var{filename}
4014 @itemx --output @var{filename}
4015 The name of the output file. If this option is not used, then
4016 @command{windres} will use the first non-option argument, after any used
4017 for the input file name, as the output file name. If there is no
4018 non-option argument, then @command{windres} will write to standard output.
4019 @command{windres} can not write a COFF file to standard output. Note,
4020 for compatibility with @command{rc} the option @option{-fo} is also
4021 accepted, but its use is not recommended.
4023 @item -J @var{format}
4024 @itemx --input-format @var{format}
4025 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4026 @samp{coff}. If no input format is specified, @command{windres} will
4027 guess, as described above.
4029 @item -O @var{format}
4030 @itemx --output-format @var{format}
4031 The output format to generate. @var{format} may be @samp{res},
4032 @samp{rc}, or @samp{coff}. If no output format is specified,
4033 @command{windres} will guess, as described above.
4035 @item -F @var{target}
4036 @itemx --target @var{target}
4037 Specify the BFD format to use for a COFF file as input or output. This
4038 is a BFD target name; you can use the @option{--help} option to see a list
4039 of supported targets. Normally @command{windres} will use the default
4040 format, which is the first one listed by the @option{--help} option.
4042 @ref{Target Selection}.
4045 @item --preprocessor @var{program}
4046 When @command{windres} reads an @code{rc} file, it runs it through the C
4047 preprocessor first. This option may be used to specify the preprocessor
4048 to use, including any leading arguments. The default preprocessor
4049 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4051 @item --preprocessor-arg @var{option}
4052 When @command{windres} reads an @code{rc} file, it runs it through
4053 the C preprocessor first. This option may be used to specify additional
4054 text to be passed to preprocessor on its command line.
4055 This option can be used multiple times to add multiple options to the
4056 preprocessor command line.
4058 @item -I @var{directory}
4059 @itemx --include-dir @var{directory}
4060 Specify an include directory to use when reading an @code{rc} file.
4061 @command{windres} will pass this to the preprocessor as an @option{-I}
4062 option. @command{windres} will also search this directory when looking for
4063 files named in the @code{rc} file. If the argument passed to this command
4064 matches any of the supported @var{formats} (as described in the @option{-J}
4065 option), it will issue a deprecation warning, and behave just like the
4066 @option{-J} option. New programs should not use this behaviour. If a
4067 directory happens to match a @var{format}, simple prefix it with @samp{./}
4068 to disable the backward compatibility.
4070 @item -D @var{target}
4071 @itemx --define @var{sym}[=@var{val}]
4072 Specify a @option{-D} option to pass to the preprocessor when reading an
4075 @item -U @var{target}
4076 @itemx --undefine @var{sym}
4077 Specify a @option{-U} option to pass to the preprocessor when reading an
4081 Ignored for compatibility with rc.
4084 Enable verbose mode. This tells you what the preprocessor is if you
4088 @item --codepage @var{val}
4089 Specify the default codepage to use when reading an @code{rc} file.
4090 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4091 codepage code. The valid range is from zero up to 0xffff, but the
4092 validity of the codepage is host and configuration dependent.
4095 @item --language @var{val}
4096 Specify the default language to use when reading an @code{rc} file.
4097 @var{val} should be a hexadecimal language code. The low eight bits are
4098 the language, and the high eight bits are the sublanguage.
4100 @item --use-temp-file
4101 Use a temporary file to instead of using popen to read the output of
4102 the preprocessor. Use this option if the popen implementation is buggy
4103 on the host (eg., certain non-English language versions of Windows 95 and
4104 Windows 98 are known to have buggy popen where the output will instead
4107 @item --no-use-temp-file
4108 Use popen, not a temporary file, to read the output of the preprocessor.
4109 This is the default behaviour.
4113 Prints a usage summary.
4117 Prints the version number for @command{windres}.
4120 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4121 this will turn on parser debugging.
4127 @c man begin SEEALSO windres
4128 the Info entries for @file{binutils}.
4137 @command{dlltool} is used to create the files needed to create dynamic
4138 link libraries (DLLs) on systems which understand PE format image
4139 files such as Windows. A DLL contains an export table which contains
4140 information that the runtime loader needs to resolve references from a
4141 referencing program.
4143 The export table is generated by this program by reading in a
4144 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4145 will be in the DLL. A @file{.o} file can contain information in
4146 special @samp{.drectve} sections with export information.
4149 @emph{Note:} @command{dlltool} is not always built as part of the
4150 binary utilities, since it is only useful for those targets which
4154 @c man title dlltool Create files needed to build and use DLLs.
4157 @c man begin SYNOPSIS dlltool
4158 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4159 [@option{-b}|@option{--base-file} @var{base-file-name}]
4160 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4161 [@option{-z}|@option{--output-def} @var{def-file-name}]
4162 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4163 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4164 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4165 [@option{--exclude-symbols} @var{list}]
4166 [@option{--no-default-excludes}]
4167 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4168 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4169 [@option{-a}|@option{--add-indirect}]
4170 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4171 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4172 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4173 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4174 [@option{--use-nul-prefixed-import-tables}]
4175 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4176 [@option{-i}|@option{--interwork}]
4177 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4178 [@option{-v}|@option{--verbose}]
4179 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4180 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4181 [object-file @dots{}]
4185 @c man begin DESCRIPTION dlltool
4187 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4188 @option{-b} options as well as object files specified on the command
4189 line. It then processes these inputs and if the @option{-e} option has
4190 been specified it creates a exports file. If the @option{-l} option
4191 has been specified it creates a library file and if the @option{-z} option
4192 has been specified it creates a def file. Any or all of the @option{-e},
4193 @option{-l} and @option{-z} options can be present in one invocation of
4196 When creating a DLL, along with the source for the DLL, it is necessary
4197 to have three other files. @command{dlltool} can help with the creation of
4200 The first file is a @file{.def} file which specifies which functions are
4201 exported from the DLL, which functions the DLL imports, and so on. This
4202 is a text file and can be created by hand, or @command{dlltool} can be used
4203 to create it using the @option{-z} option. In this case @command{dlltool}
4204 will scan the object files specified on its command line looking for
4205 those functions which have been specially marked as being exported and
4206 put entries for them in the @file{.def} file it creates.
4208 In order to mark a function as being exported from a DLL, it needs to
4209 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4210 section of the object file. This can be done in C by using the
4214 asm (".section .drectve");
4215 asm (".ascii \"-export:my_func\"");
4217 int my_func (void) @{ @dots{} @}
4220 The second file needed for DLL creation is an exports file. This file
4221 is linked with the object files that make up the body of the DLL and it
4222 handles the interface between the DLL and the outside world. This is a
4223 binary file and it can be created by giving the @option{-e} option to
4224 @command{dlltool} when it is creating or reading in a @file{.def} file.
4226 The third file needed for DLL creation is the library file that programs
4227 will link with in order to access the functions in the DLL (an `import
4228 library'). This file can be created by giving the @option{-l} option to
4229 dlltool when it is creating or reading in a @file{.def} file.
4231 If the @option{-y} option is specified, dlltool generates a delay-import
4232 library that can be used instead of the normal import library to allow
4233 a program to link to the dll only as soon as an imported function is
4234 called for the first time. The resulting executable will need to be
4235 linked to the static delayimp library containing __delayLoadHelper2(),
4236 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4238 @command{dlltool} builds the library file by hand, but it builds the
4239 exports file by creating temporary files containing assembler statements
4240 and then assembling these. The @option{-S} command line option can be
4241 used to specify the path to the assembler that dlltool will use,
4242 and the @option{-f} option can be used to pass specific flags to that
4243 assembler. The @option{-n} can be used to prevent dlltool from deleting
4244 these temporary assembler files when it is done, and if @option{-n} is
4245 specified twice then this will prevent dlltool from deleting the
4246 temporary object files it used to build the library.
4248 Here is an example of creating a DLL from a source file @samp{dll.c} and
4249 also creating a program (from an object file called @samp{program.o})
4254 dlltool -e exports.o -l dll.lib dll.o
4255 gcc dll.o exports.o -o dll.dll
4256 gcc program.o dll.lib -o program
4260 @command{dlltool} may also be used to query an existing import library
4261 to determine the name of the DLL to which it is associated. See the
4262 description of the @option{-I} or @option{--identify} option.
4266 @c man begin OPTIONS dlltool
4268 The command line options have the following meanings:
4272 @item -d @var{filename}
4273 @itemx --input-def @var{filename}
4274 @cindex input .def file
4275 Specifies the name of a @file{.def} file to be read in and processed.
4277 @item -b @var{filename}
4278 @itemx --base-file @var{filename}
4280 Specifies the name of a base file to be read in and processed. The
4281 contents of this file will be added to the relocation section in the
4282 exports file generated by dlltool.
4284 @item -e @var{filename}
4285 @itemx --output-exp @var{filename}
4286 Specifies the name of the export file to be created by dlltool.
4288 @item -z @var{filename}
4289 @itemx --output-def @var{filename}
4290 Specifies the name of the @file{.def} file to be created by dlltool.
4292 @item -l @var{filename}
4293 @itemx --output-lib @var{filename}
4294 Specifies the name of the library file to be created by dlltool.
4296 @item -y @var{filename}
4297 @itemx --output-delaylib @var{filename}
4298 Specifies the name of the delay-import library file to be created by dlltool.
4300 @item --export-all-symbols
4301 Treat all global and weak defined symbols found in the input object
4302 files as symbols to be exported. There is a small list of symbols which
4303 are not exported by default; see the @option{--no-default-excludes}
4304 option. You may add to the list of symbols to not export by using the
4305 @option{--exclude-symbols} option.
4307 @item --no-export-all-symbols
4308 Only export symbols explicitly listed in an input @file{.def} file or in
4309 @samp{.drectve} sections in the input object files. This is the default
4310 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4311 attributes in the source code.
4313 @item --exclude-symbols @var{list}
4314 Do not export the symbols in @var{list}. This is a list of symbol names
4315 separated by comma or colon characters. The symbol names should not
4316 contain a leading underscore. This is only meaningful when
4317 @option{--export-all-symbols} is used.
4319 @item --no-default-excludes
4320 When @option{--export-all-symbols} is used, it will by default avoid
4321 exporting certain special symbols. The current list of symbols to avoid
4322 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4323 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4324 to go ahead and export these special symbols. This is only meaningful
4325 when @option{--export-all-symbols} is used.
4328 @itemx --as @var{path}
4329 Specifies the path, including the filename, of the assembler to be used
4330 to create the exports file.
4332 @item -f @var{options}
4333 @itemx --as-flags @var{options}
4334 Specifies any specific command line options to be passed to the
4335 assembler when building the exports file. This option will work even if
4336 the @option{-S} option is not used. This option only takes one argument,
4337 and if it occurs more than once on the command line, then later
4338 occurrences will override earlier occurrences. So if it is necessary to
4339 pass multiple options to the assembler they should be enclosed in
4343 @itemx --dll-name @var{name}
4344 Specifies the name to be stored in the @file{.def} file as the name of
4345 the DLL when the @option{-e} option is used. If this option is not
4346 present, then the filename given to the @option{-e} option will be
4347 used as the name of the DLL.
4349 @item -m @var{machine}
4350 @itemx -machine @var{machine}
4351 Specifies the type of machine for which the library file should be
4352 built. @command{dlltool} has a built in default type, depending upon how
4353 it was created, but this option can be used to override that. This is
4354 normally only useful when creating DLLs for an ARM processor, when the
4355 contents of the DLL are actually encode using Thumb instructions.
4358 @itemx --add-indirect
4359 Specifies that when @command{dlltool} is creating the exports file it
4360 should add a section which allows the exported functions to be
4361 referenced without using the import library. Whatever the hell that
4365 @itemx --add-underscore
4366 Specifies that when @command{dlltool} is creating the exports file it
4367 should prepend an underscore to the names of @emph{all} exported symbols.
4369 @item --no-leading-underscore
4370 @item --leading-underscore
4371 Specifies whether standard symbol should be forced to be prefixed, or
4374 @item --add-stdcall-underscore
4375 Specifies that when @command{dlltool} is creating the exports file it
4376 should prepend an underscore to the names of exported @emph{stdcall}
4377 functions. Variable names and non-stdcall function names are not modified.
4378 This option is useful when creating GNU-compatible import libs for third
4379 party DLLs that were built with MS-Windows tools.
4383 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4384 of stdcall functions that will be imported from the DLL. This is
4385 useful when creating an import library for a DLL which exports stdcall
4386 functions but without the usual @samp{@@<number>} symbol name suffix.
4388 This does not change the naming of symbols provided by the import library
4389 to programs linked against it, but only the entries in the import table
4390 (ie the .idata section).
4393 @itemx --add-stdcall-alias
4394 Specifies that when @command{dlltool} is creating the exports file it
4395 should add aliases for stdcall symbols without @samp{@@ <number>}
4396 in addition to the symbols with @samp{@@ <number>}.
4399 @itemx --ext-prefix-alias @var{prefix}
4400 Causes @command{dlltool} to create external aliases for all DLL
4401 imports with the specified prefix. The aliases are created for both
4402 external and import symbols with no leading underscore.
4406 Specifies that when @command{dlltool} is creating the exports and library
4407 files it should omit the @code{.idata4} section. This is for compatibility
4408 with certain operating systems.
4410 @item --use-nul-prefixed-import-tables
4411 Specifies that when @command{dlltool} is creating the exports and library
4412 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4413 element. This emulates old gnu import library generation of
4414 @code{dlltool}. By default this option is turned off.
4418 Specifies that when @command{dlltool} is creating the exports and library
4419 files it should omit the @code{.idata5} section. This is for compatibility
4420 with certain operating systems.
4422 @item -I @var{filename}
4423 @itemx --identify @var{filename}
4424 Specifies that @command{dlltool} should inspect the import library
4425 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4426 of the associated DLL(s). This can be performed in addition to any
4427 other operations indicated by the other options and arguments.
4428 @command{dlltool} fails if the import library does not exist or is not
4429 actually an import library. See also @option{--identify-strict}.
4431 @item --identify-strict
4432 Modifies the behavior of the @option{--identify} option, such
4433 that an error is reported if @var{filename} is associated with
4438 Specifies that @command{dlltool} should mark the objects in the library
4439 file and exports file that it produces as supporting interworking
4440 between ARM and Thumb code.
4444 Makes @command{dlltool} preserve the temporary assembler files it used to
4445 create the exports file. If this option is repeated then dlltool will
4446 also preserve the temporary object files it uses to create the library
4449 @item -t @var{prefix}
4450 @itemx --temp-prefix @var{prefix}
4451 Makes @command{dlltool} use @var{prefix} when constructing the names of
4452 temporary assembler and object files. By default, the temp file prefix
4453 is generated from the pid.
4457 Make dlltool describe what it is doing.
4461 Displays a list of command line options and then exits.
4465 Displays dlltool's version number and then exits.
4472 * def file format:: The format of the dlltool @file{.def} file
4475 @node def file format
4476 @section The format of the @command{dlltool} @file{.def} file
4478 A @file{.def} file contains any number of the following commands:
4482 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4483 The result is going to be named @var{name}@code{.exe}.
4485 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4486 The result is going to be named @var{name}@code{.dll}.
4487 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4488 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4491 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4492 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4493 Declares @var{name1} as an exported symbol from the DLL, with optional
4494 ordinal number @var{integer}, or declares @var{name1} as an alias
4495 (forward) of the function @var{external-name} in the DLL.
4496 If @var{its_name} is specified, this name is used as string in export table.
4498 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4499 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4500 If you want to use LIBRARY as name then you need to quote it.
4502 @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{]} *}
4503 Declares that @var{external-name} or the exported function whose
4504 ordinal number is @var{integer} is to be imported from the file
4505 @var{module-name}. If @var{internal-name} is specified then this is
4506 the name that the imported function will be referred to in the body of
4508 If @var{its_name} is specified, this name is used as string in import table.
4509 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4510 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4511 If you want to use LIBRARY as name then you need to quote it.
4513 @item @code{DESCRIPTION} @var{string}
4514 Puts @var{string} into the output @file{.exp} file in the
4515 @code{.rdata} section.
4517 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4518 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4519 Generates @code{--stack} or @code{--heap}
4520 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4521 section. The linker will see this and act upon it.
4523 @item @code{CODE} @var{attr} @code{+}
4524 @item @code{DATA} @var{attr} @code{+}
4525 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4526 Generates @code{--attr} @var{section-name} @var{attr} in the output
4527 @code{.drectve} section, where @var{attr} is one of @code{READ},
4528 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4529 this and act upon it.
4534 @c man begin SEEALSO dlltool
4535 The Info pages for @file{binutils}.
4542 @cindex ELF file information
4545 @c man title readelf Displays information about ELF files.
4548 @c man begin SYNOPSIS readelf
4549 readelf [@option{-a}|@option{--all}]
4550 [@option{-h}|@option{--file-header}]
4551 [@option{-l}|@option{--program-headers}|@option{--segments}]
4552 [@option{-S}|@option{--section-headers}|@option{--sections}]
4553 [@option{-g}|@option{--section-groups}]
4554 [@option{-t}|@option{--section-details}]
4555 [@option{-e}|@option{--headers}]
4556 [@option{-s}|@option{--syms}|@option{--symbols}]
4557 [@option{--dyn-syms}]
4558 [@option{-n}|@option{--notes}]
4559 [@option{-r}|@option{--relocs}]
4560 [@option{-u}|@option{--unwind}]
4561 [@option{-d}|@option{--dynamic}]
4562 [@option{-V}|@option{--version-info}]
4563 [@option{-A}|@option{--arch-specific}]
4564 [@option{-D}|@option{--use-dynamic}]
4565 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4566 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4567 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4568 [@option{-z}|@option{--decompress}]
4569 [@option{-c}|@option{--archive-index}]
4570 [@option{-w[lLiaprmfFsoRt]}|
4571 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
4572 [@option{--dwarf-depth=@var{n}}]
4573 [@option{--dwarf-start=@var{n}}]
4574 [@option{-I}|@option{--histogram}]
4575 [@option{-v}|@option{--version}]
4576 [@option{-W}|@option{--wide}]
4577 [@option{-H}|@option{--help}]
4578 @var{elffile}@dots{}
4582 @c man begin DESCRIPTION readelf
4584 @command{readelf} displays information about one or more ELF format object
4585 files. The options control what particular information to display.
4587 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4588 64-bit ELF files are supported, as are archives containing ELF files.
4590 This program performs a similar function to @command{objdump} but it
4591 goes into more detail and it exists independently of the @sc{bfd}
4592 library, so if there is a bug in @sc{bfd} then readelf will not be
4597 @c man begin OPTIONS readelf
4599 The long and short forms of options, shown here as alternatives, are
4600 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4606 Equivalent to specifying @option{--file-header},
4607 @option{--program-headers}, @option{--sections}, @option{--symbols},
4608 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4609 @option{--version-info}.
4612 @itemx --file-header
4613 @cindex ELF file header information
4614 Displays the information contained in the ELF header at the start of the
4618 @itemx --program-headers
4620 @cindex ELF program header information
4621 @cindex ELF segment information
4622 Displays the information contained in the file's segment headers, if it
4627 @itemx --section-headers
4628 @cindex ELF section information
4629 Displays the information contained in the file's section headers, if it
4633 @itemx --section-groups
4634 @cindex ELF section group information
4635 Displays the information contained in the file's section groups, if it
4639 @itemx --section-details
4640 @cindex ELF section information
4641 Displays the detailed section information. Implies @option{-S}.
4646 @cindex ELF symbol table information
4647 Displays the entries in symbol table section of the file, if it has one.
4648 If a symbol has version information associated with it then this is
4649 displayed as well. The version string is displayed as a suffix to the
4650 symbol name, preceeded by an @@ character. For example
4651 @samp{foo@@VER_1}. If the version is the default version to be used
4652 when resolving unversioned references to the symbol then it is
4653 displayed as a suffix preceeded by two @@ characters. For example
4654 @samp{foo@@@@VER_2}.
4657 @cindex ELF dynamic symbol table information
4658 Displays the entries in dynamic symbol table section of the file, if it
4659 has one. The output format is the same as the format used by the
4660 @option{--syms} option.
4664 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4669 Displays the contents of the NOTE segments and/or sections, if any.
4673 @cindex ELF reloc information
4674 Displays the contents of the file's relocation section, if it has one.
4678 @cindex unwind information
4679 Displays the contents of the file's unwind section, if it has one. Only
4680 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4681 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4685 @cindex ELF dynamic section information
4686 Displays the contents of the file's dynamic section, if it has one.
4689 @itemx --version-info
4690 @cindex ELF version sections information
4691 Displays the contents of the version sections in the file, it they
4695 @itemx --arch-specific
4696 Displays architecture-specific information in the file, if there
4700 @itemx --use-dynamic
4701 When displaying symbols, this option makes @command{readelf} use the
4702 symbol hash tables in the file's dynamic section, rather than the
4703 symbol table sections.
4705 @item -x <number or name>
4706 @itemx --hex-dump=<number or name>
4707 Displays the contents of the indicated section as a hexadecimal bytes.
4708 A number identifies a particular section by index in the section table;
4709 any other string identifies all sections with that name in the object file.
4711 @item -R <number or name>
4712 @itemx --relocated-dump=<number or name>
4713 Displays the contents of the indicated section as a hexadecimal
4714 bytes. A number identifies a particular section by index in the
4715 section table; any other string identifies all sections with that name
4716 in the object file. The contents of the section will be relocated
4717 before they are displayed.
4719 @item -p <number or name>
4720 @itemx --string-dump=<number or name>
4721 Displays the contents of the indicated section as printable strings.
4722 A number identifies a particular section by index in the section table;
4723 any other string identifies all sections with that name in the object file.
4727 Requests that the section(s) being dumped by @option{x}, @option{R} or
4728 @option{p} options are decompressed before being displayed. If the
4729 section(s) are not compressed then they are displayed as is.
4732 @itemx --archive-index
4733 @cindex Archive file symbol index information
4734 Displays the file symbol index information contained in the header part
4735 of binary archives. Performs the same function as the @option{t}
4736 command to @command{ar}, but without using the BFD library. @xref{ar}.
4738 @item -w[lLiaprmfFsoRt]
4739 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
4740 Displays the contents of the debug sections in the file, if any are
4741 present. If one of the optional letters or words follows the switch
4742 then only data found in those specific sections will be dumped.
4744 Note that there is no single letter option to display the content of
4745 trace sections or .gdb_index.
4747 Note: the @option{=decodedline} option will display the interpreted
4748 contents of a .debug_line section whereas the @option{=rawline} option
4749 dumps the contents in a raw format.
4751 Note: the @option{=frames-interp} option will display the interpreted
4752 contents of a .debug_frame section whereas the @option{=frames} option
4753 dumps the contents in a raw format.
4755 Note: the output from the @option{=info} option can also be affected
4756 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4758 @item --dwarf-depth=@var{n}
4759 Limit the dump of the @code{.debug_info} section to @var{n} children.
4760 This is only useful with @option{--debug-dump=info}. The default is
4761 to print all DIEs; the special value 0 for @var{n} will also have this
4764 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4765 levels will not be printed. The range for @var{n} is zero-based.
4767 @item --dwarf-start=@var{n}
4768 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4769 useful with @option{--debug-dump=info}.
4771 If specified, this option will suppress printing of any header
4772 information and all DIEs before the DIE numbered @var{n}. Only
4773 siblings and children of the specified DIE will be printed.
4775 This can be used in conjunction with @option{--dwarf-depth}.
4779 Display a histogram of bucket list lengths when displaying the contents
4780 of the symbol tables.
4784 Display the version number of readelf.
4788 Don't break output lines to fit into 80 columns. By default
4789 @command{readelf} breaks section header and segment listing lines for
4790 64-bit ELF files, so that they fit into 80 columns. This option causes
4791 @command{readelf} to print each section header resp. each segment one a
4792 single line, which is far more readable on terminals wider than 80 columns.
4796 Display the command line options understood by @command{readelf}.
4803 @c man begin SEEALSO readelf
4804 objdump(1), and the Info entries for @file{binutils}.
4811 @cindex Update ELF header
4814 @c man title elfedit Update the ELF header of ELF files.
4817 @c man begin SYNOPSIS elfedit
4818 elfedit [@option{--input-mach=}@var{machine}]
4819 [@option{--input-type=}@var{type}]
4820 [@option{--input-osabi=}@var{osabi}]
4821 @option{--output-mach=}@var{machine}
4822 @option{--output-type=}@var{type}
4823 @option{--output-osabi=}@var{osabi}
4824 [@option{-v}|@option{--version}]
4825 [@option{-h}|@option{--help}]
4826 @var{elffile}@dots{}
4830 @c man begin DESCRIPTION elfedit
4832 @command{elfedit} updates the ELF header of ELF files which have
4833 the matching ELF machine and file types. The options control how and
4834 which fields in the ELF header should be updated.
4836 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4837 64-bit ELF files are supported, as are archives containing ELF files.
4840 @c man begin OPTIONS elfedit
4842 The long and short forms of options, shown here as alternatives, are
4843 equivalent. At least one of the @option{--output-mach},
4844 @option{--output-type} and @option{--output-osabi} options must be given.
4848 @item --input-mach=@var{machine}
4849 Set the matching input ELF machine type to @var{machine}. If
4850 @option{--input-mach} isn't specified, it will match any ELF
4853 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4854 @var{K1OM} and @var{x86-64}.
4856 @item --output-mach=@var{machine}
4857 Change the ELF machine type in the ELF header to @var{machine}. The
4858 supported ELF machine types are the same as @option{--input-mach}.
4860 @item --input-type=@var{type}
4861 Set the matching input ELF file type to @var{type}. If
4862 @option{--input-type} isn't specified, it will match any ELF file types.
4864 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4866 @item --output-type=@var{type}
4867 Change the ELF file type in the ELF header to @var{type}. The
4868 supported ELF types are the same as @option{--input-type}.
4870 @item --input-osabi=@var{osabi}
4871 Set the matching input ELF file OSABI to @var{osabi}. If
4872 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4874 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4875 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4876 @var{Solaris}, @var{AIX}, @var{Irix},
4877 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4878 @var{NSK}, @var{AROS} and @var{FenixOS}.
4880 @item --output-osabi=@var{osabi}
4881 Change the ELF OSABI in the ELF header to @var{osabi}. The
4882 supported ELF OSABI are the same as @option{--input-osabi}.
4886 Display the version number of @command{elfedit}.
4890 Display the command line options understood by @command{elfedit}.
4897 @c man begin SEEALSO elfedit
4898 readelf(1), and the Info entries for @file{binutils}.
4902 @node Common Options
4903 @chapter Common Options
4905 The following command-line options are supported by all of the
4906 programs described in this manual.
4908 @c man begin OPTIONS
4910 @include at-file.texi
4914 Display the command-line options supported by the program.
4917 Display the version number of the program.
4919 @c man begin OPTIONS
4923 @node Selecting the Target System
4924 @chapter Selecting the Target System
4926 You can specify two aspects of the target system to the @sc{gnu}
4927 binary file utilities, each in several ways:
4937 In the following summaries, the lists of ways to specify values are in
4938 order of decreasing precedence. The ways listed first override those
4941 The commands to list valid values only list the values for which the
4942 programs you are running were configured. If they were configured with
4943 @option{--enable-targets=all}, the commands list most of the available
4944 values, but a few are left out; not all targets can be configured in at
4945 once because some of them can only be configured @dfn{native} (on hosts
4946 with the same type as the target system).
4949 * Target Selection::
4950 * Architecture Selection::
4953 @node Target Selection
4954 @section Target Selection
4956 A @dfn{target} is an object file format. A given target may be
4957 supported for multiple architectures (@pxref{Architecture Selection}).
4958 A target selection may also have variations for different operating
4959 systems or architectures.
4961 The command to list valid target values is @samp{objdump -i}
4962 (the first column of output contains the relevant information).
4964 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4965 @samp{a.out-sunos-big}.
4967 You can also specify a target using a configuration triplet. This is
4968 the same sort of name that is passed to @file{configure} to specify a
4969 target. When you use a configuration triplet as an argument, it must be
4970 fully canonicalized. You can see the canonical version of a triplet by
4971 running the shell script @file{config.sub} which is included with the
4974 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4975 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4977 @subheading @command{objdump} Target
4983 command line option: @option{-b} or @option{--target}
4986 environment variable @code{GNUTARGET}
4989 deduced from the input file
4992 @subheading @command{objcopy} and @command{strip} Input Target
4998 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5001 environment variable @code{GNUTARGET}
5004 deduced from the input file
5007 @subheading @command{objcopy} and @command{strip} Output Target
5013 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5016 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5019 environment variable @code{GNUTARGET}
5022 deduced from the input file
5025 @subheading @command{nm}, @command{size}, and @command{strings} Target
5031 command line option: @option{--target}
5034 environment variable @code{GNUTARGET}
5037 deduced from the input file
5040 @node Architecture Selection
5041 @section Architecture Selection
5043 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5044 to run. Its name may contain a colon, separating the name of the
5045 processor family from the name of the particular @sc{cpu}.
5047 The command to list valid architecture values is @samp{objdump -i} (the
5048 second column contains the relevant information).
5050 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5052 @subheading @command{objdump} Architecture
5058 command line option: @option{-m} or @option{--architecture}
5061 deduced from the input file
5064 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5070 deduced from the input file
5073 @node Reporting Bugs
5074 @chapter Reporting Bugs
5076 @cindex reporting bugs
5078 Your bug reports play an essential role in making the binary utilities
5081 Reporting a bug may help you by bringing a solution to your problem, or
5082 it may not. But in any case the principal function of a bug report is
5083 to help the entire community by making the next version of the binary
5084 utilities work better. Bug reports are your contribution to their
5087 In order for a bug report to serve its purpose, you must include the
5088 information that enables us to fix the bug.
5091 * Bug Criteria:: Have you found a bug?
5092 * Bug Reporting:: How to report bugs
5096 @section Have You Found a Bug?
5097 @cindex bug criteria
5099 If you are not sure whether you have found a bug, here are some guidelines:
5102 @cindex fatal signal
5105 If a binary utility gets a fatal signal, for any input whatever, that is
5106 a bug. Reliable utilities never crash.
5108 @cindex error on valid input
5110 If a binary utility produces an error message for valid input, that is a
5114 If you are an experienced user of binary utilities, your suggestions for
5115 improvement are welcome in any case.
5119 @section How to Report Bugs
5121 @cindex bugs, reporting
5123 A number of companies and individuals offer support for @sc{gnu}
5124 products. If you obtained the binary utilities from a support
5125 organization, we recommend you contact that organization first.
5127 You can find contact information for many support companies and
5128 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5132 In any event, we also recommend that you send bug reports for the binary
5133 utilities to @value{BUGURL}.
5136 The fundamental principle of reporting bugs usefully is this:
5137 @strong{report all the facts}. If you are not sure whether to state a
5138 fact or leave it out, state it!
5140 Often people omit facts because they think they know what causes the
5141 problem and assume that some details do not matter. Thus, you might
5142 assume that the name of a file you use in an example does not matter.
5143 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5144 a stray memory reference which happens to fetch from the location where
5145 that pathname is stored in memory; perhaps, if the pathname were
5146 different, the contents of that location would fool the utility into
5147 doing the right thing despite the bug. Play it safe and give a
5148 specific, complete example. That is the easiest thing for you to do,
5149 and the most helpful.
5151 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5152 it is new to us. Therefore, always write your bug reports on the assumption
5153 that the bug has not been reported previously.
5155 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5156 bell?'' This cannot help us fix a bug, so it is basically useless. We
5157 respond by asking for enough details to enable us to investigate.
5158 You might as well expedite matters by sending them to begin with.
5160 To enable us to fix the bug, you should include all these things:
5164 The version of the utility. Each utility announces it if you start it
5165 with the @option{--version} argument.
5167 Without this, we will not know whether there is any point in looking for
5168 the bug in the current version of the binary utilities.
5171 Any patches you may have applied to the source, including any patches
5172 made to the @code{BFD} library.
5175 The type of machine you are using, and the operating system name and
5179 What compiler (and its version) was used to compile the utilities---e.g.
5183 The command arguments you gave the utility to observe the bug. To
5184 guarantee you will not omit something important, list them all. A copy
5185 of the Makefile (or the output from make) is sufficient.
5187 If we were to try to guess the arguments, we would probably guess wrong
5188 and then we might not encounter the bug.
5191 A complete input file, or set of input files, that will reproduce the
5192 bug. If the utility is reading an object file or files, then it is
5193 generally most helpful to send the actual object files.
5195 If the source files were produced exclusively using @sc{gnu} programs
5196 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5197 may be OK to send the source files rather than the object files. In
5198 this case, be sure to say exactly what version of @command{gcc}, or
5199 whatever, was used to produce the object files. Also say how
5200 @command{gcc}, or whatever, was configured.
5203 A description of what behavior you observe that you believe is
5204 incorrect. For example, ``It gets a fatal signal.''
5206 Of course, if the bug is that the utility gets a fatal signal, then we
5207 will certainly notice it. But if the bug is incorrect output, we might
5208 not notice unless it is glaringly wrong. You might as well not give us
5209 a chance to make a mistake.
5211 Even if the problem you experience is a fatal signal, you should still
5212 say so explicitly. Suppose something strange is going on, such as your
5213 copy of the utility is out of sync, or you have encountered a bug in
5214 the C library on your system. (This has happened!) Your copy might
5215 crash and ours would not. If you told us to expect a crash, then when
5216 ours fails to crash, we would know that the bug was not happening for
5217 us. If you had not told us to expect a crash, then we would not be able
5218 to draw any conclusion from our observations.
5221 If you wish to suggest changes to the source, send us context diffs, as
5222 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5223 option. Always send diffs from the old file to the new file. If you
5224 wish to discuss something in the @command{ld} source, refer to it by
5225 context, not by line number.
5227 The line numbers in our development sources will not match those in your
5228 sources. Your line numbers would convey no useful information to us.
5231 Here are some things that are not necessary:
5235 A description of the envelope of the bug.
5237 Often people who encounter a bug spend a lot of time investigating
5238 which changes to the input file will make the bug go away and which
5239 changes will not affect it.
5241 This is often time consuming and not very useful, because the way we
5242 will find the bug is by running a single example under the debugger
5243 with breakpoints, not by pure deduction from a series of examples.
5244 We recommend that you save your time for something else.
5246 Of course, if you can find a simpler example to report @emph{instead}
5247 of the original one, that is a convenience for us. Errors in the
5248 output will be easier to spot, running under the debugger will take
5249 less time, and so on.
5251 However, simplification is not vital; if you do not want to do this,
5252 report the bug anyway and send us the entire test case you used.
5255 A patch for the bug.
5257 A patch for the bug does help us if it is a good one. But do not omit
5258 the necessary information, such as the test case, on the assumption that
5259 a patch is all we need. We might see problems with your patch and decide
5260 to fix the problem another way, or we might not understand it at all.
5262 Sometimes with programs as complicated as the binary utilities it is
5263 very hard to construct an example that will make the program follow a
5264 certain path through the code. If you do not send us the example, we
5265 will not be able to construct one, so we will not be able to verify that
5268 And if we cannot understand what bug you are trying to fix, or why your
5269 patch should be an improvement, we will not install it. A test case will
5270 help us to understand.
5273 A guess about what the bug is or what it depends on.
5275 Such guesses are usually wrong. Even we cannot guess right about such
5276 things without first using the debugger to find the facts.
5279 @node GNU Free Documentation License
5280 @appendix GNU Free Documentation License
5284 @node Binutils Index
5285 @unnumbered Binutils Index