1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2019 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 * nm: (binutils)nm. List symbols from object files.
38 * objcopy: (binutils)objcopy. Copy and translate object files.
39 * objdump: (binutils)objdump. Display information from object files.
40 * ranlib: (binutils)ranlib. Generate index to archive contents.
41 * readelf: (binutils)readelf. Display the contents of ELF format files.
42 * size: (binutils)size. List section sizes and total size.
43 * strings: (binutils)strings. List printable strings from files.
44 * strip: (binutils)strip. Discard symbols.
45 * elfedit: (binutils)elfedit. Update ELF header and property of ELF files.
46 * windmc: (binutils)windmc. Generator for Windows message resources.
47 * windres: (binutils)windres. Manipulate Windows resources.
51 @title The @sc{gnu} Binary Utilities
52 @ifset VERSION_PACKAGE
53 @subtitle @value{VERSION_PACKAGE}
55 @subtitle Version @value{VERSION}
57 @subtitle @value{UPDATED}
58 @author Roland H. Pesch
59 @author Jeffrey M. Osier
60 @author Cygnus Support
64 {\parskip=0pt \hfill Cygnus Support\par \hfill
65 Texinfo \texinfoversion\par }
68 @vskip 0pt plus 1filll
77 This brief manual contains documentation for the @sc{gnu} binary
79 @ifset VERSION_PACKAGE
80 @value{VERSION_PACKAGE}
82 version @value{VERSION}:
87 Create, modify, and extract from archives
90 List symbols from object files
93 Copy and translate object files
96 Display information from object files
99 Generate index to archive contents
102 Display the contents of ELF format files.
105 List file section sizes and total size
108 List printable strings from files
114 Update the ELF header and program property of ELF files.
117 Demangle encoded C++ symbols (on MS-DOS, this program is named
121 Convert addresses into file names and line numbers
124 Manipulate Windows resources
127 Generator for Windows message resources
130 Create the files needed to build and use Dynamic Link Libraries
134 This document is distributed under the terms of the GNU Free
135 Documentation License version 1.3. A copy of the license is included
136 in the section entitled ``GNU Free Documentation License''.
139 * ar:: Create, modify, and extract from archives
140 * nm:: List symbols from object files
141 * objcopy:: Copy and translate object files
142 * objdump:: Display information from object files
143 * ranlib:: Generate index to archive contents
144 * size:: List section sizes and total size
145 * strings:: List printable strings from files
146 * strip:: Discard symbols
147 * c++filt:: Filter to demangle encoded C++ symbols
148 * cxxfilt: c++filt. MS-DOS name for c++filt
149 * addr2line:: Convert addresses to file and line
150 * windmc:: Generator for Windows message resources
151 * windres:: Manipulate Windows resources
152 * dlltool:: Create files needed to build and use DLLs
153 * readelf:: Display the contents of ELF format files
154 * elfedit:: Update ELF header and property of ELF files
155 * Common Options:: Command-line options for all utilities
156 * Selecting the Target System:: How these utilities determine the target
157 * Reporting Bugs:: Reporting Bugs
158 * GNU Free Documentation License:: GNU Free Documentation License
159 * Binutils Index:: Binutils Index
167 @cindex collections of files
169 @c man title ar create, modify, and extract from archives
172 ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
173 ar -M [ <mri-script ]
176 @c man begin DESCRIPTION ar
178 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
179 archives. An @dfn{archive} is a single file holding a collection of
180 other files in a structure that makes it possible to retrieve
181 the original individual files (called @dfn{members} of the archive).
183 The original files' contents, mode (permissions), timestamp, owner, and
184 group are preserved in the archive, and can be restored on
188 @sc{gnu} @command{ar} can maintain archives whose members have names of any
189 length; however, depending on how @command{ar} is configured on your
190 system, a limit on member-name length may be imposed for compatibility
191 with archive formats maintained with other tools. If it exists, the
192 limit is often 15 characters (typical of formats related to a.out) or 16
193 characters (typical of formats related to coff).
196 @command{ar} is considered a binary utility because archives of this sort
197 are most often used as @dfn{libraries} holding commonly needed
201 @command{ar} creates an index to the symbols defined in relocatable
202 object modules in the archive when you specify the modifier @samp{s}.
203 Once created, this index is updated in the archive whenever @command{ar}
204 makes a change to its contents (save for the @samp{q} update operation).
205 An archive with such an index speeds up linking to the library, and
206 allows routines in the library to call each other without regard to
207 their placement in the archive.
209 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
210 table. If an archive lacks the table, another form of @command{ar} called
211 @command{ranlib} can be used to add just the table.
213 @cindex thin archives
214 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
215 which contains a symbol index and references to the original copies
216 of the member files of the archive. This is useful for building
217 libraries for use within a local build tree, where the relocatable
218 objects are expected to remain available, and copying the contents of
219 each object would only waste time and space.
221 An archive can either be @emph{thin} or it can be normal. It cannot
222 be both at the same time. Once an archive is created its format
223 cannot be changed without first deleting it and then creating a new
224 archive in its place.
226 Thin archives are also @emph{flattened}, so that adding one thin
227 archive to another thin archive does not nest it, as would happen with
228 a normal archive. Instead the elements of the first archive are added
229 individually to the second archive.
231 The paths to the elements of the archive are stored relative to the
234 @cindex compatibility, @command{ar}
235 @cindex @command{ar} compatibility
236 @sc{gnu} @command{ar} is designed to be compatible with two different
237 facilities. You can control its activity using command-line options,
238 like the different varieties of @command{ar} on Unix systems; or, if you
239 specify the single command-line option @option{-M}, you can control it
240 with a script supplied via standard input, like the MRI ``librarian''
246 * ar cmdline:: Controlling @command{ar} on the command line
247 * ar scripts:: Controlling @command{ar} with a script
252 @section Controlling @command{ar} on the Command Line
255 @c man begin SYNOPSIS ar
256 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{}]
260 @cindex Unix compatibility, @command{ar}
261 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
262 arguments to execute: one keyletter specifying the @emph{operation}
263 (optionally accompanied by other keyletters specifying
264 @emph{modifiers}), and the archive name to act on.
266 Most operations can also accept further @var{member} arguments,
267 specifying particular files to operate on.
269 @c man begin OPTIONS ar
271 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
272 flags @var{mod} in any order, within the first command-line argument.
274 If you wish, you may begin the first command-line argument with a
277 @cindex operations on archive
278 The @var{p} keyletter specifies what operation to execute; it may be
279 any of the following, but you must specify only one of them:
283 @cindex deleting from archive
284 @emph{Delete} modules from the archive. Specify the names of modules to
285 be deleted as @var{member}@dots{}; the archive is untouched if you
286 specify no files to delete.
288 If you specify the @samp{v} modifier, @command{ar} lists each module
292 @cindex moving in archive
293 Use this operation to @emph{move} members in an archive.
295 The ordering of members in an archive can make a difference in how
296 programs are linked using the library, if a symbol is defined in more
299 If no modifiers are used with @code{m}, any members you name in the
300 @var{member} arguments are moved to the @emph{end} of the archive;
301 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
302 specified place instead.
305 @cindex printing from archive
306 @emph{Print} the specified members of the archive, to the standard
307 output file. If the @samp{v} modifier is specified, show the member
308 name before copying its contents to standard output.
310 If you specify no @var{member} arguments, all the files in the archive are
314 @cindex quick append to archive
315 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
316 @var{archive}, without checking for replacement.
318 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
319 operation; new members are always placed at the end of the archive.
321 The modifier @samp{v} makes @command{ar} list each file as it is appended.
323 Since the point of this operation is speed, implementations of
324 @command{ar} have the option of not updating the archive's symbol
325 table if one exists. Too many different systems however assume that
326 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
327 rebuild the table even with a quick append.
329 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
330 synonym for @samp{r} - replacing already existing files in the
331 archive and appending new ones at the end.
334 @cindex replacement in archive
335 Insert the files @var{member}@dots{} into @var{archive} (with
336 @emph{replacement}). This operation differs from @samp{q} in that any
337 previously existing members are deleted if their names match those being
340 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
341 displays an error message, and leaves undisturbed any existing members
342 of the archive matching that name.
344 By default, new members are added at the end of the file; but you may
345 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
346 placement relative to some existing member.
348 The modifier @samp{v} used with this operation elicits a line of
349 output for each file inserted, along with one of the letters @samp{a} or
350 @samp{r} to indicate whether the file was appended (no old member
351 deleted) or replaced.
355 Add an index to the archive, or update it if it already exists. Note
356 this command is an exception to the rule that there can only be one
357 command letter, as it is possible to use it as either a command or a
358 modifier. In either case it does the same thing.
361 @cindex contents of archive
362 Display a @emph{table} listing the contents of @var{archive}, or those
363 of the files listed in @var{member}@dots{} that are present in the
364 archive. Normally only the member name is shown, but if the modifier
365 @samp{O} is specified, then the corresponding offset of the member is also
366 displayed. Finally, in order to see the modes (permissions), timestamp,
367 owner, group, and size the @samp{v} modifier should be included.
369 If you do not specify a @var{member}, all files in the archive
372 @cindex repeated names in archive
373 @cindex name duplication in archive
374 If there is more than one file with the same name (say, @samp{fie}) in
375 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
376 first instance; to see them all, you must ask for a complete
377 listing---in our example, @samp{ar t b.a}.
378 @c WRS only; per Gumby, this is implementation-dependent, and in a more
379 @c recent case in fact works the other way.
382 @cindex extract from archive
383 @emph{Extract} members (named @var{member}) from the archive. You can
384 use the @samp{v} modifier with this operation, to request that
385 @command{ar} list each name as it extracts it.
387 If you do not specify a @var{member}, all files in the archive
390 Files cannot be extracted from a thin archive.
393 A number of modifiers (@var{mod}) may immediately follow the @var{p}
394 keyletter, to specify variations on an operation's behavior:
398 @cindex relative placement in archive
399 Add new files @emph{after} an existing member of the
400 archive. If you use the modifier @samp{a}, the name of an existing archive
401 member must be present as the @var{relpos} argument, before the
402 @var{archive} specification.
405 Add new files @emph{before} an existing member of the
406 archive. If you use the modifier @samp{b}, the name of an existing archive
407 member must be present as the @var{relpos} argument, before the
408 @var{archive} specification. (same as @samp{i}).
411 @cindex creating archives
412 @emph{Create} the archive. The specified @var{archive} is always
413 created if it did not exist, when you request an update. But a warning is
414 issued unless you specify in advance that you expect to create it, by
418 @cindex deterministic archives
419 @kindex --enable-deterministic-archives
420 Operate in @emph{deterministic} mode. When adding files and the archive
421 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
422 for all files. When this option is used, if @command{ar} is used with
423 identical options and identical input files, multiple runs will create
424 identical output files regardless of the input files' owners, groups,
425 file modes, or modification times.
427 If @file{binutils} was configured with
428 @option{--enable-deterministic-archives}, then this mode is on by default.
429 It can be disabled with the @samp{U} modifier, below.
432 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
433 names of any length. This will cause it to create archives which are
434 not compatible with the native @command{ar} program on some systems. If
435 this is a concern, the @samp{f} modifier may be used to truncate file
436 names when putting them in the archive.
439 Insert new files @emph{before} an existing member of the
440 archive. If you use the modifier @samp{i}, the name of an existing archive
441 member must be present as the @var{relpos} argument, before the
442 @var{archive} specification. (same as @samp{b}).
445 This modifier is accepted but not used.
446 @c whaffor ar l modifier??? presumably compat; with
447 @c what???---doc@@cygnus.com, 25jan91
450 Uses the @var{count} parameter. This is used if there are multiple
451 entries in the archive with the same name. Extract or delete instance
452 @var{count} of the given name from the archive.
455 @cindex dates in archive
456 Preserve the @emph{original} dates of members when extracting them. If
457 you do not specify this modifier, files extracted from the archive
458 are stamped with the time of extraction.
461 @cindex offsets of files
462 Display member offsets inside the archive. Use together with the @samp{t}
466 Use the full path name when matching names in the archive. @sc{gnu}
467 @command{ar} can not create an archive with a full path name (such archives
468 are not POSIX compliant), but other archive creators can. This option
469 will cause @sc{gnu} @command{ar} to match file names using a complete path
470 name, which can be convenient when extracting a single file from an
471 archive created by another tool.
474 @cindex writing archive index
475 Write an object-file index into the archive, or update an existing one,
476 even if no other change is made to the archive. You may use this modifier
477 flag either with any operation, or alone. Running @samp{ar s} on an
478 archive is equivalent to running @samp{ranlib} on it.
481 @cindex not writing archive index
482 Do not generate an archive symbol table. This can speed up building a
483 large library in several steps. The resulting archive can not be used
484 with the linker. In order to build a symbol table, you must omit the
485 @samp{S} modifier on the last execution of @samp{ar}, or you must run
486 @samp{ranlib} on the archive.
489 @cindex creating thin archive
490 Make the specified @var{archive} a @emph{thin} archive. If it already
491 exists and is a regular archive, the existing members must be present
492 in the same directory as @var{archive}.
495 @cindex updating an archive
496 Normally, @samp{ar r}@dots{} inserts all files
497 listed into the archive. If you would like to insert @emph{only} those
498 of the files you list that are newer than existing members of the same
499 names, use this modifier. The @samp{u} modifier is allowed only for the
500 operation @samp{r} (replace). In particular, the combination @samp{qu} is
501 not allowed, since checking the timestamps would lose any speed
502 advantage from the operation @samp{q}.
505 @cindex deterministic archives
506 @kindex --enable-deterministic-archives
507 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
508 of the @samp{D} modifier, above: added files and the archive index will
509 get their actual UID, GID, timestamp, and file mode values.
511 This is the default unless @file{binutils} was configured with
512 @option{--enable-deterministic-archives}.
515 This modifier requests the @emph{verbose} version of an operation. Many
516 operations display additional information, such as filenames processed,
517 when the modifier @samp{v} is appended.
520 This modifier shows the version number of @command{ar}.
523 The @command{ar} program also supports some command-line options which
524 are neither modifiers nor actions, but which do change its behaviour
529 Displays the list of command-line options supported by @command{ar}
533 Displays the version information of @command{ar} and then exits.
536 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
537 compatibility with AIX. The behaviour produced by this option is the
538 default for @sc{gnu} @command{ar}. @command{ar} does not support any
539 of the other @samp{-X} options; in particular, it does not support
540 @option{-X32} which is the default for AIX @command{ar}.
542 @item --plugin @var{name}
544 The optional command-line switch @option{--plugin @var{name}} causes
545 @command{ar} to load the plugin called @var{name} which adds support
546 for more file formats, including object files with link-time
547 optimization information.
549 This option is only available if the toolchain has been built with
550 plugin support enabled.
552 If @option{--plugin} is not provided, but plugin support has been
553 enabled then @command{ar} iterates over the files in
554 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
555 plugin that claims the object in question is used.
557 Please note that this plugin search directory is @emph{not} the one
558 used by @command{ld}'s @option{-plugin} option. In order to make
559 @command{ar} use the linker plugin it must be copied into the
560 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
561 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
562 based compilations it is called @file{LLVMgold.so}. The GCC plugin
563 is always backwards compatible with earlier versions, so it is
564 sufficient to just copy the newest one.
566 @item --target @var{target}
567 The optional command-line switch @option{--target @var{bfdname}}
568 specifies that the archive members are in an object code format
569 different from your system's default format. See
570 @xref{Target Selection}, for more information.
575 @c man begin SEEALSO ar
576 nm(1), ranlib(1), and the Info entries for @file{binutils}.
581 @section Controlling @command{ar} with a Script
584 ar -M [ <@var{script} ]
587 @cindex MRI compatibility, @command{ar}
588 @cindex scripts, @command{ar}
589 If you use the single command-line option @samp{-M} with @command{ar}, you
590 can control its operation with a rudimentary command language. This
591 form of @command{ar} operates interactively if standard input is coming
592 directly from a terminal. During interactive use, @command{ar} prompts for
593 input (the prompt is @samp{AR >}), and continues executing even after
594 errors. If you redirect standard input to a script file, no prompts are
595 issued, and @command{ar} abandons execution (with a nonzero exit code)
598 The @command{ar} command language is @emph{not} designed to be equivalent
599 to the command-line options; in fact, it provides somewhat less control
600 over archives. The only purpose of the command language is to ease the
601 transition to @sc{gnu} @command{ar} for developers who already have scripts
602 written for the MRI ``librarian'' program.
604 The syntax for the @command{ar} command language is straightforward:
607 commands are recognized in upper or lower case; for example, @code{LIST}
608 is the same as @code{list}. In the following descriptions, commands are
609 shown in upper case for clarity.
612 a single command may appear on each line; it is the first word on the
616 empty lines are allowed, and have no effect.
619 comments are allowed; text after either of the characters @samp{*}
620 or @samp{;} is ignored.
623 Whenever you use a list of names as part of the argument to an @command{ar}
624 command, you can separate the individual names with either commas or
625 blanks. Commas are shown in the explanations below, for clarity.
628 @samp{+} is used as a line continuation character; if @samp{+} appears
629 at the end of a line, the text on the following line is considered part
630 of the current command.
633 Here are the commands you can use in @command{ar} scripts, or when using
634 @command{ar} interactively. Three of them have special significance:
636 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
637 a temporary file required for most of the other commands.
639 @code{SAVE} commits the changes so far specified by the script. Prior
640 to @code{SAVE}, commands affect only the temporary copy of the current
644 @item ADDLIB @var{archive}
645 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
646 Add all the contents of @var{archive} (or, if specified, each named
647 @var{module} from @var{archive}) to the current archive.
649 Requires prior use of @code{OPEN} or @code{CREATE}.
651 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
652 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
653 @c else like "ar q..."
654 Add each named @var{member} as a module in the current archive.
656 Requires prior use of @code{OPEN} or @code{CREATE}.
659 Discard the contents of the current archive, canceling the effect of
660 any operations since the last @code{SAVE}. May be executed (with no
661 effect) even if no current archive is specified.
663 @item CREATE @var{archive}
664 Creates an archive, and makes it the current archive (required for many
665 other commands). The new archive is created with a temporary name; it
666 is not actually saved as @var{archive} until you use @code{SAVE}.
667 You can overwrite existing archives; similarly, the contents of any
668 existing file named @var{archive} will not be destroyed until @code{SAVE}.
670 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
671 Delete each listed @var{module} from the current archive; equivalent to
672 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
674 Requires prior use of @code{OPEN} or @code{CREATE}.
676 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
677 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
678 List each named @var{module} present in @var{archive}. The separate
679 command @code{VERBOSE} specifies the form of the output: when verbose
680 output is off, output is like that of @samp{ar -t @var{archive}
681 @var{module}@dots{}}. When verbose output is on, the listing is like
682 @samp{ar -tv @var{archive} @var{module}@dots{}}.
684 Output normally goes to the standard output stream; however, if you
685 specify @var{outputfile} as a final argument, @command{ar} directs the
689 Exit from @command{ar}, with a @code{0} exit code to indicate successful
690 completion. This command does not save the output file; if you have
691 changed the current archive since the last @code{SAVE} command, those
694 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
695 Extract each named @var{module} from the current archive, writing them
696 into the current directory as separate files. Equivalent to @samp{ar -x
697 @var{archive} @var{module}@dots{}}.
699 Requires prior use of @code{OPEN} or @code{CREATE}.
702 @c FIXME Tokens but no commands???
709 Display full contents of the current archive, in ``verbose'' style
710 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
711 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
712 enhancement, rather than present for MRI compatibility.)
714 Requires prior use of @code{OPEN} or @code{CREATE}.
716 @item OPEN @var{archive}
717 Opens an existing archive for use as the current archive (required for
718 many other commands). Any changes as the result of subsequent commands
719 will not actually affect @var{archive} until you next use @code{SAVE}.
721 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
722 In the current archive, replace each existing @var{module} (named in
723 the @code{REPLACE} arguments) from files in the current working directory.
724 To execute this command without errors, both the file, and the module in
725 the current archive, must exist.
727 Requires prior use of @code{OPEN} or @code{CREATE}.
730 Toggle an internal flag governing the output from @code{DIRECTORY}.
731 When the flag is on, @code{DIRECTORY} output matches output from
732 @samp{ar -tv }@dots{}.
735 Commit your changes to the current archive, and actually save it as a
736 file with the name specified in the last @code{CREATE} or @code{OPEN}
739 Requires prior use of @code{OPEN} or @code{CREATE}.
748 The @sc{gnu} linker @command{ld} is now described in a separate manual.
749 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
757 @c man title nm list symbols from object files
760 @c man begin SYNOPSIS nm
761 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
762 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
763 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
764 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
765 [@option{-l}|@option{--line-numbers}] [@option{--inlines}]
766 [@option{-n}|@option{-v}|@option{--numeric-sort}]
767 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
768 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
769 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
770 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
771 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
772 [@option{--plugin} @var{name}]
773 [@option{--no-recurse-limit}|@option{--recurse-limit}]]
774 [@option{--size-sort}] [@option{--special-syms}]
775 [@option{--synthetic}] [@option{--with-symbol-versions}] [@option{--target=}@var{bfdname}]
776 [@var{objfile}@dots{}]
780 @c man begin DESCRIPTION nm
781 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
782 If no object files are listed as arguments, @command{nm} assumes the file
785 For each symbol, @command{nm} shows:
789 The symbol value, in the radix selected by options (see below), or
790 hexadecimal by default.
793 The symbol type. At least the following types are used; others are, as
794 well, depending on the object file format. If lowercase, the symbol is
795 usually local; if uppercase, the symbol is global (external). There
796 are however a few lowercase symbols that are shown for special global
797 symbols (@code{u}, @code{v} and @code{w}).
799 @c Some more detail on exactly what these symbol types are used for
803 The symbol's value is absolute, and will not be changed by further
808 The symbol is in the BSS data section. This section typically
809 contains zero-initialized or uninitialized data, although the exact
810 behavior is system dependent.
813 The symbol is common. Common symbols are uninitialized data. When
814 linking, multiple common symbols may appear with the same name. If the
815 symbol is defined anywhere, the common symbols are treated as undefined
818 For more details on common symbols, see the discussion of
819 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
824 The symbol is in the initialized data section.
828 The symbol is in an initialized data section for small objects. Some
829 object file formats permit more efficient access to small data objects,
830 such as a global int variable as opposed to a large global array.
833 For PE format files this indicates that the symbol is in a section
834 specific to the implementation of DLLs. For ELF format files this
835 indicates that the symbol is an indirect function. This is a GNU
836 extension to the standard set of ELF symbol types. It indicates a
837 symbol which if referenced by a relocation does not evaluate to its
838 address, but instead must be invoked at runtime. The runtime
839 execution will then return the value to be used in the relocation.
842 The symbol is an indirect reference to another symbol.
845 The symbol is a debugging symbol.
848 The symbol is in the read-only data section.
851 The symbol is in a stack unwind section.
855 The symbol is in a read only data section.
859 The symbol is in an uninitialized or zero-initialized data section
864 The symbol is in the text (code) section.
867 The symbol is undefined.
870 The symbol is a unique global symbol. This is a GNU extension to the
871 standard set of ELF symbol bindings. For such a symbol the dynamic linker
872 will make sure that in the entire process there is just one symbol with
873 this name and type in use.
877 The symbol is a weak object. When a weak defined symbol is linked with
878 a normal defined symbol, the normal defined symbol is used with no error.
879 When a weak undefined symbol is linked and the symbol is not defined,
880 the value of the weak symbol becomes zero with no error. On some
881 systems, uppercase indicates that a default value has been specified.
885 The symbol is a weak symbol that has not been specifically tagged as a
886 weak object symbol. When a weak defined symbol is linked with a normal
887 defined symbol, the normal defined symbol is used with no error.
888 When a weak undefined symbol is linked and the symbol is not defined,
889 the value of the symbol is determined in a system-specific manner without
890 error. On some systems, uppercase indicates that a default value has been
894 The symbol is a stabs symbol in an a.out object file. In this case, the
895 next values printed are the stabs other field, the stabs desc field, and
896 the stab type. Stabs symbols are used to hold debugging information.
899 The symbol type is unknown, or object file format specific.
908 @c man begin OPTIONS nm
909 The long and short forms of options, shown here as alternatives, are
915 @itemx --print-file-name
916 @cindex input file name
918 @cindex source file name
919 Precede each symbol by the name of the input file (or archive member)
920 in which it was found, rather than identifying the input file once only,
921 before all of its symbols.
925 @cindex debugging symbols
926 Display all symbols, even debugger-only symbols; normally these are not
930 @cindex @command{nm} format
931 @cindex @command{nm} compatibility
932 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
935 @itemx --demangle[=@var{style}]
936 @cindex demangling in nm
937 Decode (@dfn{demangle}) low-level symbol names into user-level names.
938 Besides removing any initial underscore prepended by the system, this
939 makes C++ function names readable. Different compilers have different
940 mangling styles. The optional demangling style argument can be used to
941 choose an appropriate demangling style for your compiler. @xref{c++filt},
942 for more information on demangling.
945 Do not demangle low-level symbol names. This is the default.
947 @item --recurse-limit
948 @itemx --no-recurse-limit
949 @itemx --recursion-limit
950 @itemx --no-recursion-limit
951 Enables or disables a limit on the amount of recursion performed
952 whilst demangling strings. Since the name mangling formats allow for
953 an inifinite level of recursion it is possible to create strings whose
954 decoding will exhaust the amount of stack space available on the host
955 machine, triggering a memory fault. The limit tries to prevent this
956 from happening by restricting recursion to 2048 levels of nesting.
958 The default is for this limit to be enabled, but disabling it may be
959 necessary in order to demangle truly complicated names. Note however
960 that if the recursion limit is disabled then stack exhaustion is
961 possible and any bug reports about such an event will be rejected.
965 @cindex dynamic symbols
966 Display the dynamic symbols rather than the normal symbols. This is
967 only meaningful for dynamic objects, such as certain types of shared
970 @item -f @var{format}
971 @itemx --format=@var{format}
972 @cindex @command{nm} format
973 @cindex @command{nm} compatibility
974 Use the output format @var{format}, which can be @code{bsd},
975 @code{sysv}, or @code{posix}. The default is @code{bsd}.
976 Only the first character of @var{format} is significant; it can be
977 either upper or lower case.
981 @cindex external symbols
982 Display only external symbols.
986 Show a summary of the options to @command{nm} and exit.
989 @itemx --line-numbers
990 @cindex symbol line numbers
991 For each symbol, use debugging information to try to find a filename and
992 line number. For a defined symbol, look for the line number of the
993 address of the symbol. For an undefined symbol, look for the line
994 number of a relocation entry which refers to the symbol. If line number
995 information can be found, print it after the other symbol information.
998 @cindex objdump inlines
999 When option @option{-l} is active, if the address belongs to a
1000 function that was inlined, then this option causes the source
1001 information for all enclosing scopes back to the first non-inlined
1002 function to be printed as well. For example, if @code{main} inlines
1003 @code{callee1} which inlines @code{callee2}, and address is from
1004 @code{callee2}, the source information for @code{callee1} and @code{main}
1005 will also be printed.
1009 @itemx --numeric-sort
1010 Sort symbols numerically by their addresses, rather than alphabetically
1015 @cindex sorting symbols
1016 Do not bother to sort the symbols in any order; print them in the order
1020 @itemx --portability
1021 Use the POSIX.2 standard output format instead of the default format.
1022 Equivalent to @samp{-f posix}.
1025 @itemx --reverse-sort
1026 Reverse the order of the sort (whether numeric or alphabetic); let the
1031 Print both value and size of defined symbols for the @code{bsd} output style.
1032 This option has no effect for object formats that do not record symbol
1033 sizes, unless @samp{--size-sort} is also used in which case a
1034 calculated size is displayed.
1037 @itemx --print-armap
1038 @cindex symbol index, listing
1039 When listing symbols from archive members, include the index: a mapping
1040 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
1041 contain definitions for which names.
1043 @item -t @var{radix}
1044 @itemx --radix=@var{radix}
1045 Use @var{radix} as the radix for printing the symbol values. It must be
1046 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
1049 @itemx --undefined-only
1050 @cindex external symbols
1051 @cindex undefined symbols
1052 Display only undefined symbols (those external to each object file).
1056 Show the version number of @command{nm} and exit.
1059 This option is ignored for compatibility with the AIX version of
1060 @command{nm}. It takes one parameter which must be the string
1061 @option{32_64}. The default mode of AIX @command{nm} corresponds
1062 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1064 @item --defined-only
1065 @cindex external symbols
1066 @cindex undefined symbols
1067 Display only defined symbols for each object file.
1069 @item --plugin @var{name}
1071 Load the plugin called @var{name} to add support for extra target
1072 types. This option is only available if the toolchain has been built
1073 with plugin support enabled.
1075 If @option{--plugin} is not provided, but plugin support has been
1076 enabled then @command{nm} iterates over the files in
1077 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
1078 plugin that claims the object in question is used.
1080 Please note that this plugin search directory is @emph{not} the one
1081 used by @command{ld}'s @option{-plugin} option. In order to make
1082 @command{nm} use the linker plugin it must be copied into the
1083 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
1084 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
1085 based compilations it is called @file{LLVMgold.so}. The GCC plugin
1086 is always backwards compatible with earlier versions, so it is
1087 sufficient to just copy the newest one.
1090 Sort symbols by size. For ELF objects symbol sizes are read from the
1091 ELF, for other object types the symbol sizes are computed as the
1092 difference between the value of the symbol and the value of the symbol
1093 with the next higher value. If the @code{bsd} output format is used
1094 the size of the symbol is printed, rather than the value, and
1095 @samp{-S} must be used in order both size and value to be printed.
1097 @item --special-syms
1098 Display symbols which have a target-specific special meaning. These
1099 symbols are usually used by the target for some special processing and
1100 are not normally helpful when included in the normal symbol lists.
1101 For example for ARM targets this option would skip the mapping symbols
1102 used to mark transitions between ARM code, THUMB code and data.
1105 Include synthetic symbols in the output. These are special symbols
1106 created by the linker for various purposes. They are not shown by
1107 default since they are not part of the binary's original source code.
1109 @item --with-symbol-versions
1110 Enables the display of symbol version information if any exists. The
1111 version string is displayed as a suffix to the symbol name, preceeded by
1112 an @@ character. For example @samp{foo@@VER_1}. If the version is
1113 the default version to be used when resolving unversioned references
1114 to the symbol then it is displayed as a suffix preceeded by two @@
1115 characters. For example @samp{foo@@@@VER_2}.
1117 @item --target=@var{bfdname}
1118 @cindex object code format
1119 Specify an object code format other than your system's default format.
1120 @xref{Target Selection}, for more information.
1127 @c man begin SEEALSO nm
1128 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1135 @c man title objcopy copy and translate object files
1138 @c man begin SYNOPSIS objcopy
1139 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1140 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1141 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1142 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1143 [@option{-S}|@option{--strip-all}]
1144 [@option{-g}|@option{--strip-debug}]
1145 [@option{--strip-unneeded}]
1146 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1147 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1148 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1149 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1150 [@option{--localize-hidden}]
1151 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1152 [@option{--globalize-symbol=}@var{symbolname}]
1153 [@option{--globalize-symbols=}@var{filename}]
1154 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1155 [@option{-w}|@option{--wildcard}]
1156 [@option{-x}|@option{--discard-all}]
1157 [@option{-X}|@option{--discard-locals}]
1158 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1159 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1160 [@option{--interleave-width=}@var{width}]
1161 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1162 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1163 [@option{--remove-relocations=}@var{sectionpattern}]
1164 [@option{-p}|@option{--preserve-dates}]
1165 [@option{-D}|@option{--enable-deterministic-archives}]
1166 [@option{-U}|@option{--disable-deterministic-archives}]
1167 [@option{--debugging}]
1168 [@option{--gap-fill=}@var{val}]
1169 [@option{--pad-to=}@var{address}]
1170 [@option{--set-start=}@var{val}]
1171 [@option{--adjust-start=}@var{incr}]
1172 [@option{--change-addresses=}@var{incr}]
1173 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1174 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1175 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1176 [@option{--change-warnings}] [@option{--no-change-warnings}]
1177 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1178 [@option{--add-section} @var{sectionname}=@var{filename}]
1179 [@option{--dump-section} @var{sectionname}=@var{filename}]
1180 [@option{--update-section} @var{sectionname}=@var{filename}]
1181 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1182 [@option{--long-section-names} @{enable,disable,keep@}]
1183 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1184 [@option{--reverse-bytes=}@var{num}]
1185 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1186 [@option{--redefine-sym} @var{old}=@var{new}]
1187 [@option{--redefine-syms=}@var{filename}]
1189 [@option{--keep-symbols=}@var{filename}]
1190 [@option{--strip-symbols=}@var{filename}]
1191 [@option{--strip-unneeded-symbols=}@var{filename}]
1192 [@option{--keep-global-symbols=}@var{filename}]
1193 [@option{--localize-symbols=}@var{filename}]
1194 [@option{--weaken-symbols=}@var{filename}]
1195 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]]
1196 [@option{--alt-machine-code=}@var{index}]
1197 [@option{--prefix-symbols=}@var{string}]
1198 [@option{--prefix-sections=}@var{string}]
1199 [@option{--prefix-alloc-sections=}@var{string}]
1200 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1201 [@option{--keep-file-symbols}]
1202 [@option{--only-keep-debug}]
1203 [@option{--strip-dwo}]
1204 [@option{--extract-dwo}]
1205 [@option{--extract-symbol}]
1206 [@option{--writable-text}]
1207 [@option{--readonly-text}]
1210 [@option{--file-alignment=}@var{num}]
1211 [@option{--heap=}@var{size}]
1212 [@option{--image-base=}@var{address}]
1213 [@option{--section-alignment=}@var{num}]
1214 [@option{--stack=}@var{size}]
1215 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1216 [@option{--compress-debug-sections}]
1217 [@option{--decompress-debug-sections}]
1218 [@option{--elf-stt-common=@var{val}}]
1219 [@option{--merge-notes}]
1220 [@option{--no-merge-notes}]
1221 [@option{--verilog-data-width=@var{val}}]
1222 [@option{-v}|@option{--verbose}]
1223 [@option{-V}|@option{--version}]
1224 [@option{--help}] [@option{--info}]
1225 @var{infile} [@var{outfile}]
1229 @c man begin DESCRIPTION objcopy
1230 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1231 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1232 read and write the object files. It can write the destination object
1233 file in a format different from that of the source object file. The
1234 exact behavior of @command{objcopy} is controlled by command-line options.
1235 Note that @command{objcopy} should be able to copy a fully linked file
1236 between any two formats. However, copying a relocatable object file
1237 between any two formats may not work as expected.
1239 @command{objcopy} creates temporary files to do its translations and
1240 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1241 translation work; it has access to all the formats described in @sc{bfd}
1242 and thus is able to recognize most formats without being told
1243 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1245 @command{objcopy} can be used to generate S-records by using an output
1246 target of @samp{srec} (e.g., use @samp{-O srec}).
1248 @command{objcopy} can be used to generate a raw binary file by using an
1249 output target of @samp{binary} (e.g., use @option{-O binary}). When
1250 @command{objcopy} generates a raw binary file, it will essentially produce
1251 a memory dump of the contents of the input object file. All symbols and
1252 relocation information will be discarded. The memory dump will start at
1253 the load address of the lowest section copied into the output file.
1255 When generating an S-record or a raw binary file, it may be helpful to
1256 use @option{-S} to remove sections containing debugging information. In
1257 some cases @option{-R} will be useful to remove sections which contain
1258 information that is not needed by the binary file.
1260 Note---@command{objcopy} is not able to change the endianness of its input
1261 files. If the input format has an endianness (some formats do not),
1262 @command{objcopy} can only copy the inputs into file formats that have the
1263 same endianness or which have no endianness (e.g., @samp{srec}).
1264 (However, see the @option{--reverse-bytes} option.)
1268 @c man begin OPTIONS objcopy
1272 @itemx @var{outfile}
1273 The input and output files, respectively.
1274 If you do not specify @var{outfile}, @command{objcopy} creates a
1275 temporary file and destructively renames the result with
1276 the name of @var{infile}.
1278 @item -I @var{bfdname}
1279 @itemx --input-target=@var{bfdname}
1280 Consider the source file's object format to be @var{bfdname}, rather than
1281 attempting to deduce it. @xref{Target Selection}, for more information.
1283 @item -O @var{bfdname}
1284 @itemx --output-target=@var{bfdname}
1285 Write the output file using the object format @var{bfdname}.
1286 @xref{Target Selection}, for more information.
1288 @item -F @var{bfdname}
1289 @itemx --target=@var{bfdname}
1290 Use @var{bfdname} as the object format for both the input and the output
1291 file; i.e., simply transfer data from source to destination with no
1292 translation. @xref{Target Selection}, for more information.
1294 @item -B @var{bfdarch}
1295 @itemx --binary-architecture=@var{bfdarch}
1296 Useful when transforming a architecture-less input file into an object file.
1297 In this case the output architecture can be set to @var{bfdarch}. This
1298 option will be ignored if the input file has a known @var{bfdarch}. You
1299 can access this binary data inside a program by referencing the special
1300 symbols that are created by the conversion process. These symbols are
1301 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1302 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1303 an object file and then access it in your code using these symbols.
1305 @item -j @var{sectionpattern}
1306 @itemx --only-section=@var{sectionpattern}
1307 Copy only the indicated sections from the input file to the output file.
1308 This option may be given more than once. Note that using this option
1309 inappropriately may make the output file unusable. Wildcard
1310 characters are accepted in @var{sectionpattern}.
1312 If the first character of @var{sectionpattern} is the exclamation
1313 point (!) then matching sections will not be copied, even if earlier
1314 use of @option{--only-section} on the same command line would
1315 otherwise copy it. For example:
1318 --only-section=.text.* --only-section=!.text.foo
1321 will copy all sectinos maching '.text.*' but not the section
1324 @item -R @var{sectionpattern}
1325 @itemx --remove-section=@var{sectionpattern}
1326 Remove any section matching @var{sectionpattern} from the output file.
1327 This option may be given more than once. Note that using this option
1328 inappropriately may make the output file unusable. Wildcard
1329 characters are accepted in @var{sectionpattern}. Using both the
1330 @option{-j} and @option{-R} options together results in undefined
1333 If the first character of @var{sectionpattern} is the exclamation
1334 point (!) then matching sections will not be removed even if an
1335 earlier use of @option{--remove-section} on the same command line
1336 would otherwise remove it. For example:
1339 --remove-section=.text.* --remove-section=!.text.foo
1342 will remove all sections matching the pattern '.text.*', but will not
1343 remove the section '.text.foo'.
1345 @item --remove-relocations=@var{sectionpattern}
1346 Remove non-dynamic relocations from the output file for any section
1347 matching @var{sectionpattern}. This option may be given more than
1348 once. Note that using this option inappropriately may make the output
1349 file unusable, and attempting to remove a dynamic relocation section
1350 such as @samp{.rela.plt} from an executable or shared library with
1351 @option{--remove-relocations=.plt} will not work. Wildcard characters
1352 are accepted in @var{sectionpattern}.
1356 --remove-relocations=.text.*
1359 will remove the relocations for all sections matching the pattern
1362 If the first character of @var{sectionpattern} is the exclamation
1363 point (!) then matching sections will not have their relocation
1364 removed even if an earlier use of @option{--remove-relocations} on the
1365 same command line would otherwise cause the relocations to be removed.
1369 --remove-relocations=.text.* --remove-relocations=!.text.foo
1372 will remove all relocations for sections matching the pattern
1373 '.text.*', but will not remove relocations for the section
1378 Do not copy relocation and symbol information from the source file.
1381 @itemx --strip-debug
1382 Do not copy debugging symbols or sections from the source file.
1384 @item --strip-unneeded
1385 Strip all symbols that are not needed for relocation processing.
1387 @item -K @var{symbolname}
1388 @itemx --keep-symbol=@var{symbolname}
1389 When stripping symbols, keep symbol @var{symbolname} even if it would
1390 normally be stripped. This option may be given more than once.
1392 @item -N @var{symbolname}
1393 @itemx --strip-symbol=@var{symbolname}
1394 Do not copy symbol @var{symbolname} from the source file. This option
1395 may be given more than once.
1397 @item --strip-unneeded-symbol=@var{symbolname}
1398 Do not copy symbol @var{symbolname} from the source file unless it is needed
1399 by a relocation. This option may be given more than once.
1401 @item -G @var{symbolname}
1402 @itemx --keep-global-symbol=@var{symbolname}
1403 Keep only symbol @var{symbolname} global. Make all other symbols local
1404 to the file, so that they are not visible externally. This option may
1405 be given more than once. Note: this option cannot be used in
1406 conjunction with the @option{--globalize-symbol} or
1407 @option{--globalize-symbols} options.
1409 @item --localize-hidden
1410 In an ELF object, mark all symbols that have hidden or internal visibility
1411 as local. This option applies on top of symbol-specific localization options
1412 such as @option{-L}.
1414 @item -L @var{symbolname}
1415 @itemx --localize-symbol=@var{symbolname}
1416 Convert a global or weak symbol called @var{symbolname} into a local
1417 symbol, so that it is not visible externally. This option may be
1418 given more than once. Note - unique symbols are not converted.
1420 @item -W @var{symbolname}
1421 @itemx --weaken-symbol=@var{symbolname}
1422 Make symbol @var{symbolname} weak. This option may be given more than once.
1424 @item --globalize-symbol=@var{symbolname}
1425 Give symbol @var{symbolname} global scoping so that it is visible
1426 outside of the file in which it is defined. This option may be given
1427 more than once. Note: this option cannot be used in conjunction with
1428 the @option{-G} or @option{--keep-global-symbol} options.
1432 Permit regular expressions in @var{symbolname}s used in other command
1433 line options. The question mark (?), asterisk (*), backslash (\) and
1434 square brackets ([]) operators can be used anywhere in the symbol
1435 name. If the first character of the symbol name is the exclamation
1436 point (!) then the sense of the switch is reversed for that symbol.
1443 would cause objcopy to weaken all symbols that start with ``fo''
1444 except for the symbol ``foo''.
1447 @itemx --discard-all
1448 Do not copy non-global symbols from the source file.
1449 @c FIXME any reason to prefer "non-global" to "local" here?
1452 @itemx --discard-locals
1453 Do not copy compiler-generated local symbols.
1454 (These usually start with @samp{L} or @samp{.}.)
1457 @itemx --byte=@var{byte}
1458 If interleaving has been enabled via the @option{--interleave} option
1459 then start the range of bytes to keep at the @var{byte}th byte.
1460 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1461 @var{breadth} is the value given by the @option{--interleave} option.
1463 @item -i [@var{breadth}]
1464 @itemx --interleave[=@var{breadth}]
1465 Only copy a range out of every @var{breadth} bytes. (Header data is
1466 not affected). Select which byte in the range begins the copy with
1467 the @option{--byte} option. Select the width of the range with the
1468 @option{--interleave-width} option.
1470 This option is useful for creating files to program @sc{rom}. It is
1471 typically used with an @code{srec} output target. Note that
1472 @command{objcopy} will complain if you do not specify the
1473 @option{--byte} option as well.
1475 The default interleave breadth is 4, so with @option{--byte} set to 0,
1476 @command{objcopy} would copy the first byte out of every four bytes
1477 from the input to the output.
1479 @item --interleave-width=@var{width}
1480 When used with the @option{--interleave} option, copy @var{width}
1481 bytes at a time. The start of the range of bytes to be copied is set
1482 by the @option{--byte} option, and the extent of the range is set with
1483 the @option{--interleave} option.
1485 The default value for this option is 1. The value of @var{width} plus
1486 the @var{byte} value set by the @option{--byte} option must not exceed
1487 the interleave breadth set by the @option{--interleave} option.
1489 This option can be used to create images for two 16-bit flashes interleaved
1490 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1491 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1492 commands. If the input was '12345678' then the outputs would be
1493 '1256' and '3478' respectively.
1496 @itemx --preserve-dates
1497 Set the access and modification dates of the output file to be the same
1498 as those of the input file.
1501 @itemx --enable-deterministic-archives
1502 @cindex deterministic archives
1503 @kindex --enable-deterministic-archives
1504 Operate in @emph{deterministic} mode. When copying archive members
1505 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1506 and use consistent file modes for all files.
1508 If @file{binutils} was configured with
1509 @option{--enable-deterministic-archives}, then this mode is on by default.
1510 It can be disabled with the @samp{-U} option, below.
1513 @itemx --disable-deterministic-archives
1514 @cindex deterministic archives
1515 @kindex --enable-deterministic-archives
1516 Do @emph{not} operate in @emph{deterministic} mode. This is the
1517 inverse of the @option{-D} option, above: when copying archive members
1518 and writing the archive index, use their actual UID, GID, timestamp,
1519 and file mode values.
1521 This is the default unless @file{binutils} was configured with
1522 @option{--enable-deterministic-archives}.
1525 Convert debugging information, if possible. This is not the default
1526 because only certain debugging formats are supported, and the
1527 conversion process can be time consuming.
1529 @item --gap-fill @var{val}
1530 Fill gaps between sections with @var{val}. This operation applies to
1531 the @emph{load address} (LMA) of the sections. It is done by increasing
1532 the size of the section with the lower address, and filling in the extra
1533 space created with @var{val}.
1535 @item --pad-to @var{address}
1536 Pad the output file up to the load address @var{address}. This is
1537 done by increasing the size of the last section. The extra space is
1538 filled in with the value specified by @option{--gap-fill} (default zero).
1540 @item --set-start @var{val}
1541 Set the start address of the new file to @var{val}. Not all object file
1542 formats support setting the start address.
1544 @item --change-start @var{incr}
1545 @itemx --adjust-start @var{incr}
1546 @cindex changing start address
1547 Change the start address by adding @var{incr}. Not all object file
1548 formats support setting the start address.
1550 @item --change-addresses @var{incr}
1551 @itemx --adjust-vma @var{incr}
1552 @cindex changing object addresses
1553 Change the VMA and LMA addresses of all sections, as well as the start
1554 address, by adding @var{incr}. Some object file formats do not permit
1555 section addresses to be changed arbitrarily. Note that this does not
1556 relocate the sections; if the program expects sections to be loaded at a
1557 certain address, and this option is used to change the sections such
1558 that they are loaded at a different address, the program may fail.
1560 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1561 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1562 @cindex changing section address
1563 Set or change both the VMA address and the LMA address of any section
1564 matching @var{sectionpattern}. If @samp{=} is used, the section
1565 address is set to @var{val}. Otherwise, @var{val} is added to or
1566 subtracted from the section address. See the comments under
1567 @option{--change-addresses}, above. If @var{sectionpattern} does not
1568 match any sections in the input file, a warning will be issued, unless
1569 @option{--no-change-warnings} is used.
1571 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1572 @cindex changing section LMA
1573 Set or change the LMA address of any sections matching
1574 @var{sectionpattern}. The LMA address is the address where the
1575 section will be loaded into memory at program load time. Normally
1576 this is the same as the VMA address, which is the address of the
1577 section at program run time, but on some systems, especially those
1578 where a program is held in ROM, the two can be different. If @samp{=}
1579 is used, the section address is set to @var{val}. Otherwise,
1580 @var{val} is added to or subtracted from the section address. See the
1581 comments under @option{--change-addresses}, above. If
1582 @var{sectionpattern} does not match any sections in the input file, a
1583 warning will be issued, unless @option{--no-change-warnings} is used.
1585 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1586 @cindex changing section VMA
1587 Set or change the VMA address of any section matching
1588 @var{sectionpattern}. The VMA address is the address where the
1589 section will be located once the program has started executing.
1590 Normally this is the same as the LMA address, which is the address
1591 where the section will be loaded into memory, but on some systems,
1592 especially those where a program is held in ROM, the two can be
1593 different. If @samp{=} is used, the section address is set to
1594 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1595 section address. See the comments under @option{--change-addresses},
1596 above. If @var{sectionpattern} does not match any sections in the
1597 input file, a warning will be issued, unless
1598 @option{--no-change-warnings} is used.
1600 @item --change-warnings
1601 @itemx --adjust-warnings
1602 If @option{--change-section-address} or @option{--change-section-lma} or
1603 @option{--change-section-vma} is used, and the section pattern does not
1604 match any sections, issue a warning. This is the default.
1606 @item --no-change-warnings
1607 @itemx --no-adjust-warnings
1608 Do not issue a warning if @option{--change-section-address} or
1609 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1610 if the section pattern does not match any sections.
1612 @item --set-section-flags @var{sectionpattern}=@var{flags}
1613 Set the flags for any sections matching @var{sectionpattern}. The
1614 @var{flags} argument is a comma separated string of flag names. The
1615 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1616 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1617 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1618 for a section which does not have contents, but it is not meaningful
1619 to clear the @samp{contents} flag of a section which does have
1620 contents--just remove the section instead. Not all flags are
1621 meaningful for all object file formats.
1623 @item --add-section @var{sectionname}=@var{filename}
1624 Add a new section named @var{sectionname} while copying the file. The
1625 contents of the new section are taken from the file @var{filename}. The
1626 size of the section will be the size of the file. This option only
1627 works on file formats which can support sections with arbitrary names.
1628 Note - it may be necessary to use the @option{--set-section-flags}
1629 option to set the attributes of the newly created section.
1631 @item --dump-section @var{sectionname}=@var{filename}
1632 Place the contents of section named @var{sectionname} into the file
1633 @var{filename}, overwriting any contents that may have been there
1634 previously. This option is the inverse of @option{--add-section}.
1635 This option is similar to the @option{--only-section} option except
1636 that it does not create a formatted file, it just dumps the contents
1637 as raw binary data, without applying any relocations. The option can
1638 be specified more than once.
1640 @item --update-section @var{sectionname}=@var{filename}
1641 Replace the existing contents of a section named @var{sectionname}
1642 with the contents of file @var{filename}. The size of the section
1643 will be adjusted to the size of the file. The section flags for
1644 @var{sectionname} will be unchanged. For ELF format files the section
1645 to segment mapping will also remain unchanged, something which is not
1646 possible using @option{--remove-section} followed by
1647 @option{--add-section}. The option can be specified more than once.
1649 Note - it is possible to use @option{--rename-section} and
1650 @option{--update-section} to both update and rename a section from one
1651 command line. In this case, pass the original section name to
1652 @option{--update-section}, and the original and new section names to
1653 @option{--rename-section}.
1655 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1656 Add a new symbol named @var{name} while copying the file. This option may be
1657 specified multiple times. If the @var{section} is given, the symbol will be
1658 associated with and relative to that section, otherwise it will be an ABS
1659 symbol. Specifying an undefined section will result in a fatal error. There
1660 is no check for the value, it will be taken as specified. Symbol flags can
1661 be specified and not all flags will be meaningful for all object file
1662 formats. By default, the symbol will be global. The special flag
1663 'before=@var{othersym}' will insert the new symbol in front of the specified
1664 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1665 symbol table in the order they appear.
1667 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1668 Rename a section from @var{oldname} to @var{newname}, optionally
1669 changing the section's flags to @var{flags} in the process. This has
1670 the advantage over using a linker script to perform the rename in that
1671 the output stays as an object file and does not become a linked
1674 This option is particularly helpful when the input format is binary,
1675 since this will always create a section called .data. If for example,
1676 you wanted instead to create a section called .rodata containing binary
1677 data you could use the following command line to achieve it:
1680 objcopy -I binary -O <output_format> -B <architecture> \
1681 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1682 <input_binary_file> <output_object_file>
1685 @item --long-section-names @{enable,disable,keep@}
1686 Controls the handling of long section names when processing @code{COFF}
1687 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1688 is to preserve long section names if any are present in the input file.
1689 The @samp{enable} and @samp{disable} options forcibly enable or disable
1690 the use of long section names in the output object; when @samp{disable}
1691 is in effect, any long section names in the input object will be truncated.
1692 The @samp{enable} option will only emit long section names if any are
1693 present in the inputs; this is mostly the same as @samp{keep}, but it
1694 is left undefined whether the @samp{enable} option might force the
1695 creation of an empty string table in the output file.
1697 @item --change-leading-char
1698 Some object file formats use special characters at the start of
1699 symbols. The most common such character is underscore, which compilers
1700 often add before every symbol. This option tells @command{objcopy} to
1701 change the leading character of every symbol when it converts between
1702 object file formats. If the object file formats use the same leading
1703 character, this option has no effect. Otherwise, it will add a
1704 character, or remove a character, or change a character, as
1707 @item --remove-leading-char
1708 If the first character of a global symbol is a special symbol leading
1709 character used by the object file format, remove the character. The
1710 most common symbol leading character is underscore. This option will
1711 remove a leading underscore from all global symbols. This can be useful
1712 if you want to link together objects of different file formats with
1713 different conventions for symbol names. This is different from
1714 @option{--change-leading-char} because it always changes the symbol name
1715 when appropriate, regardless of the object file format of the output
1718 @item --reverse-bytes=@var{num}
1719 Reverse the bytes in a section with output contents. A section length must
1720 be evenly divisible by the value given in order for the swap to be able to
1721 take place. Reversing takes place before the interleaving is performed.
1723 This option is used typically in generating ROM images for problematic
1724 target systems. For example, on some target boards, the 32-bit words
1725 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1726 regardless of the CPU byte order. Depending on the programming model, the
1727 endianness of the ROM may need to be modified.
1729 Consider a simple file with a section containing the following eight
1730 bytes: @code{12345678}.
1732 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1733 output file would be ordered @code{21436587}.
1735 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1736 output file would be ordered @code{43218765}.
1738 By using @samp{--reverse-bytes=2} for the above example, followed by
1739 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1740 output file would be ordered @code{34127856}.
1742 @item --srec-len=@var{ival}
1743 Meaningful only for srec output. Set the maximum length of the Srecords
1744 being produced to @var{ival}. This length covers both address, data and
1747 @item --srec-forceS3
1748 Meaningful only for srec output. Avoid generation of S1/S2 records,
1749 creating S3-only record format.
1751 @item --redefine-sym @var{old}=@var{new}
1752 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1753 when one is trying link two things together for which you have no
1754 source, and there are name collisions.
1756 @item --redefine-syms=@var{filename}
1757 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1758 listed in the file @var{filename}. @var{filename} is simply a flat file,
1759 with one symbol pair per line. Line comments may be introduced by the hash
1760 character. This option may be given more than once.
1763 Change all global symbols in the file to be weak. This can be useful
1764 when building an object which will be linked against other objects using
1765 the @option{-R} option to the linker. This option is only effective when
1766 using an object file format which supports weak symbols.
1768 @item --keep-symbols=@var{filename}
1769 Apply @option{--keep-symbol} option to each symbol listed in the file
1770 @var{filename}. @var{filename} is simply a flat file, with one symbol
1771 name per line. Line comments may be introduced by the hash character.
1772 This option may be given more than once.
1774 @item --strip-symbols=@var{filename}
1775 Apply @option{--strip-symbol} option to each symbol listed in the file
1776 @var{filename}. @var{filename} is simply a flat file, with one symbol
1777 name per line. Line comments may be introduced by the hash character.
1778 This option may be given more than once.
1780 @item --strip-unneeded-symbols=@var{filename}
1781 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1782 the file @var{filename}. @var{filename} is simply a flat file, with one
1783 symbol name per line. Line comments may be introduced by the hash
1784 character. This option may be given more than once.
1786 @item --keep-global-symbols=@var{filename}
1787 Apply @option{--keep-global-symbol} option to each symbol listed in the
1788 file @var{filename}. @var{filename} is simply a flat file, with one
1789 symbol name per line. Line comments may be introduced by the hash
1790 character. This option may be given more than once.
1792 @item --localize-symbols=@var{filename}
1793 Apply @option{--localize-symbol} option to each symbol listed in the file
1794 @var{filename}. @var{filename} is simply a flat file, with one symbol
1795 name per line. Line comments may be introduced by the hash character.
1796 This option may be given more than once.
1798 @item --globalize-symbols=@var{filename}
1799 Apply @option{--globalize-symbol} option to each symbol listed in the file
1800 @var{filename}. @var{filename} is simply a flat file, with one symbol
1801 name per line. Line comments may be introduced by the hash character.
1802 This option may be given more than once. Note: this option cannot be
1803 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1806 @item --weaken-symbols=@var{filename}
1807 Apply @option{--weaken-symbol} option to each symbol listed in the file
1808 @var{filename}. @var{filename} is simply a flat file, with one symbol
1809 name per line. Line comments may be introduced by the hash character.
1810 This option may be given more than once.
1812 @item --alt-machine-code=@var{index}
1813 If the output architecture has alternate machine codes, use the
1814 @var{index}th code instead of the default one. This is useful in case
1815 a machine is assigned an official code and the tool-chain adopts the
1816 new code, but other applications still depend on the original code
1817 being used. For ELF based architectures if the @var{index}
1818 alternative does not exist then the value is treated as an absolute
1819 number to be stored in the e_machine field of the ELF header.
1821 @item --writable-text
1822 Mark the output text as writable. This option isn't meaningful for all
1823 object file formats.
1825 @item --readonly-text
1826 Make the output text write protected. This option isn't meaningful for all
1827 object file formats.
1830 Mark the output file as demand paged. This option isn't meaningful for all
1831 object file formats.
1834 Mark the output file as impure. This option isn't meaningful for all
1835 object file formats.
1837 @item --prefix-symbols=@var{string}
1838 Prefix all symbols in the output file with @var{string}.
1840 @item --prefix-sections=@var{string}
1841 Prefix all section names in the output file with @var{string}.
1843 @item --prefix-alloc-sections=@var{string}
1844 Prefix all the names of all allocated sections in the output file with
1847 @item --add-gnu-debuglink=@var{path-to-file}
1848 Creates a .gnu_debuglink section which contains a reference to
1849 @var{path-to-file} and adds it to the output file. Note: the file at
1850 @var{path-to-file} must exist. Part of the process of adding the
1851 .gnu_debuglink section involves embedding a checksum of the contents
1852 of the debug info file into the section.
1854 If the debug info file is built in one location but it is going to be
1855 installed at a later time into a different location then do not use
1856 the path to the installed location. The @option{--add-gnu-debuglink}
1857 option will fail because the installed file does not exist yet.
1858 Instead put the debug info file in the current directory and use the
1859 @option{--add-gnu-debuglink} option without any directory components,
1863 objcopy --add-gnu-debuglink=foo.debug
1866 At debug time the debugger will attempt to look for the separate debug
1867 info file in a set of known locations. The exact set of these
1868 locations varies depending upon the distribution being used, but it
1873 @item * The same directory as the executable.
1875 @item * A sub-directory of the directory containing the executable
1878 @item * A global debug directory such as /usr/lib/debug.
1881 As long as the debug info file has been installed into one of these
1882 locations before the debugger is run everything should work
1885 @item --keep-file-symbols
1886 When stripping a file, perhaps with @option{--strip-debug} or
1887 @option{--strip-unneeded}, retain any symbols specifying source file names,
1888 which would otherwise get stripped.
1890 @item --only-keep-debug
1891 Strip a file, removing contents of any sections that would not be
1892 stripped by @option{--strip-debug} and leaving the debugging sections
1893 intact. In ELF files, this preserves all note sections in the output.
1895 Note - the section headers of the stripped sections are preserved,
1896 including their sizes, but the contents of the section are discarded.
1897 The section headers are preserved so that other tools can match up the
1898 debuginfo file with the real executable, even if that executable has
1899 been relocated to a different address space.
1901 The intention is that this option will be used in conjunction with
1902 @option{--add-gnu-debuglink} to create a two part executable. One a
1903 stripped binary which will occupy less space in RAM and in a
1904 distribution and the second a debugging information file which is only
1905 needed if debugging abilities are required. The suggested procedure
1906 to create these files is as follows:
1909 @item Link the executable as normal. Assuming that it is called
1911 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1912 create a file containing the debugging info.
1913 @item Run @code{objcopy --strip-debug foo} to create a
1914 stripped executable.
1915 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1916 to add a link to the debugging info into the stripped executable.
1919 Note---the choice of @code{.dbg} as an extension for the debug info
1920 file is arbitrary. Also the @code{--only-keep-debug} step is
1921 optional. You could instead do this:
1924 @item Link the executable as normal.
1925 @item Copy @code{foo} to @code{foo.full}
1926 @item Run @code{objcopy --strip-debug foo}
1927 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1930 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1931 full executable. It does not have to be a file created by the
1932 @option{--only-keep-debug} switch.
1934 Note---this switch is only intended for use on fully linked files. It
1935 does not make sense to use it on object files where the debugging
1936 information may be incomplete. Besides the gnu_debuglink feature
1937 currently only supports the presence of one filename containing
1938 debugging information, not multiple filenames on a one-per-object-file
1942 Remove the contents of all DWARF .dwo sections, leaving the
1943 remaining debugging sections and all symbols intact.
1944 This option is intended for use by the compiler as part of
1945 the @option{-gsplit-dwarf} option, which splits debug information
1946 between the .o file and a separate .dwo file. The compiler
1947 generates all debug information in the same file, then uses
1948 the @option{--extract-dwo} option to copy the .dwo sections to
1949 the .dwo file, then the @option{--strip-dwo} option to remove
1950 those sections from the original .o file.
1953 Extract the contents of all DWARF .dwo sections. See the
1954 @option{--strip-dwo} option for more information.
1956 @item --file-alignment @var{num}
1957 Specify the file alignment. Sections in the file will always begin at
1958 file offsets which are multiples of this number. This defaults to
1960 [This option is specific to PE targets.]
1962 @item --heap @var{reserve}
1963 @itemx --heap @var{reserve},@var{commit}
1964 Specify the number of bytes of memory to reserve (and optionally commit)
1965 to be used as heap for this program.
1966 [This option is specific to PE targets.]
1968 @item --image-base @var{value}
1969 Use @var{value} as the base address of your program or dll. This is
1970 the lowest memory location that will be used when your program or dll
1971 is loaded. To reduce the need to relocate and improve performance of
1972 your dlls, each should have a unique base address and not overlap any
1973 other dlls. The default is 0x400000 for executables, and 0x10000000
1975 [This option is specific to PE targets.]
1977 @item --section-alignment @var{num}
1978 Sets the section alignment. Sections in memory will always begin at
1979 addresses which are a multiple of this number. Defaults to 0x1000.
1980 [This option is specific to PE targets.]
1982 @item --stack @var{reserve}
1983 @itemx --stack @var{reserve},@var{commit}
1984 Specify the number of bytes of memory to reserve (and optionally commit)
1985 to be used as stack for this program.
1986 [This option is specific to PE targets.]
1988 @item --subsystem @var{which}
1989 @itemx --subsystem @var{which}:@var{major}
1990 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1991 Specifies the subsystem under which your program will execute. The
1992 legal values for @var{which} are @code{native}, @code{windows},
1993 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1994 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1995 the subsystem version also. Numeric values are also accepted for
1997 [This option is specific to PE targets.]
1999 @item --extract-symbol
2000 Keep the file's section flags and symbols but remove all section data.
2001 Specifically, the option:
2004 @item removes the contents of all sections;
2005 @item sets the size of every section to zero; and
2006 @item sets the file's start address to zero.
2009 This option is used to build a @file{.sym} file for a VxWorks kernel.
2010 It can also be a useful way of reducing the size of a @option{--just-symbols}
2013 @item --compress-debug-sections
2014 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2015 ELF ABI. Note - if compression would actually make a section
2016 @emph{larger}, then it is not compressed.
2018 @item --compress-debug-sections=none
2019 @itemx --compress-debug-sections=zlib
2020 @itemx --compress-debug-sections=zlib-gnu
2021 @itemx --compress-debug-sections=zlib-gabi
2022 For ELF files, these options control how DWARF debug sections are
2023 compressed. @option{--compress-debug-sections=none} is equivalent
2024 to @option{--decompress-debug-sections}.
2025 @option{--compress-debug-sections=zlib} and
2026 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2027 @option{--compress-debug-sections}.
2028 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
2029 sections using zlib. The debug sections are renamed to begin with
2030 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
2031 actually make a section @emph{larger}, then it is not compressed nor
2034 @item --decompress-debug-sections
2035 Decompress DWARF debug sections using zlib. The original section
2036 names of the compressed sections are restored.
2038 @item --elf-stt-common=yes
2039 @itemx --elf-stt-common=no
2040 For ELF files, these options control whether common symbols should be
2041 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2042 @option{--elf-stt-common=yes} converts common symbol type to
2043 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2044 type to @code{STT_OBJECT}.
2047 @itemx --no-merge-notes
2048 For ELF files, attempt (or do not attempt) to reduce the size of any
2049 SHT_NOTE type sections by removing duplicate notes.
2053 Show the version number of @command{objcopy}.
2055 @item --verilog-data-width=@var{bytes}
2056 For Verilog output, this options controls the number of bytes
2057 converted for each output data element. The input target controls the
2058 endianness of the conversion.
2062 Verbose output: list all object files modified. In the case of
2063 archives, @samp{objcopy -V} lists all members of the archive.
2066 Show a summary of the options to @command{objcopy}.
2069 Display a list showing all architectures and object formats available.
2075 @c man begin SEEALSO objcopy
2076 ld(1), objdump(1), and the Info entries for @file{binutils}.
2083 @cindex object file information
2086 @c man title objdump display information from object files
2089 @c man begin SYNOPSIS objdump
2090 objdump [@option{-a}|@option{--archive-headers}]
2091 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2092 [@option{-C}|@option{--demangle}[=@var{style}] ]
2093 [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2094 [@option{-D}|@option{--disassemble-all}]
2095 [@option{-z}|@option{--disassemble-zeroes}]
2096 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2097 [@option{-f}|@option{--file-headers}]
2098 [@option{-F}|@option{--file-offsets}]
2099 [@option{--file-start-context}]
2100 [@option{-g}|@option{--debugging}]
2101 [@option{-e}|@option{--debugging-tags}]
2102 [@option{-h}|@option{--section-headers}|@option{--headers}]
2103 [@option{-i}|@option{--info}]
2104 [@option{-j} @var{section}|@option{--section=}@var{section}]
2105 [@option{-l}|@option{--line-numbers}]
2106 [@option{-S}|@option{--source}]
2107 [@option{--source-comment}[=@var{text}]]
2108 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2109 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2110 [@option{-p}|@option{--private-headers}]
2111 [@option{-P} @var{options}|@option{--private=}@var{options}]
2112 [@option{-r}|@option{--reloc}]
2113 [@option{-R}|@option{--dynamic-reloc}]
2114 [@option{-s}|@option{--full-contents}]
2115 [@option{-W[lLiaprmfFsoRtUuTgAckK]}|
2116 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
2117 [@option{--ctf=}@var{section}]
2118 [@option{-G}|@option{--stabs}]
2119 [@option{-t}|@option{--syms}]
2120 [@option{-T}|@option{--dynamic-syms}]
2121 [@option{-x}|@option{--all-headers}]
2122 [@option{-w}|@option{--wide}]
2123 [@option{--start-address=}@var{address}]
2124 [@option{--stop-address=}@var{address}]
2125 [@option{--prefix-addresses}]
2126 [@option{--[no-]show-raw-insn}]
2127 [@option{--adjust-vma=}@var{offset}]
2128 [@option{--dwarf-depth=@var{n}}]
2129 [@option{--dwarf-start=@var{n}}]
2130 [@option{--ctf-parent=}@var{section}]
2131 [@option{--ctf-symbols=}@var{section}]
2132 [@option{--ctf-strings=}@var{section}]
2133 [@option{--no-recurse-limit}|@option{--recurse-limit}]
2134 [@option{--special-syms}]
2135 [@option{--prefix=}@var{prefix}]
2136 [@option{--prefix-strip=}@var{level}]
2137 [@option{--insn-width=}@var{width}]
2138 [@option{-V}|@option{--version}]
2139 [@option{-H}|@option{--help}]
2140 @var{objfile}@dots{}
2144 @c man begin DESCRIPTION objdump
2146 @command{objdump} displays information about one or more object files.
2147 The options control what particular information to display. This
2148 information is mostly useful to programmers who are working on the
2149 compilation tools, as opposed to programmers who just want their
2150 program to compile and work.
2152 @var{objfile}@dots{} are the object files to be examined. When you
2153 specify archives, @command{objdump} shows information on each of the member
2158 @c man begin OPTIONS objdump
2160 The long and short forms of options, shown here as alternatives, are
2161 equivalent. At least one option from the list
2162 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2166 @itemx --archive-header
2167 @cindex archive headers
2168 If any of the @var{objfile} files are archives, display the archive
2169 header information (in a format similar to @samp{ls -l}). Besides the
2170 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2171 the object file format of each archive member.
2173 @item --adjust-vma=@var{offset}
2174 @cindex section addresses in objdump
2175 @cindex VMA in objdump
2176 When dumping information, first add @var{offset} to all the section
2177 addresses. This is useful if the section addresses do not correspond to
2178 the symbol table, which can happen when putting sections at particular
2179 addresses when using a format which can not represent section addresses,
2182 @item -b @var{bfdname}
2183 @itemx --target=@var{bfdname}
2184 @cindex object code format
2185 Specify that the object-code format for the object files is
2186 @var{bfdname}. This option may not be necessary; @var{objdump} can
2187 automatically recognize many formats.
2191 objdump -b oasys -m vax -h fu.o
2194 displays summary information from the section headers (@option{-h}) of
2195 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2196 file in the format produced by Oasys compilers. You can list the
2197 formats available with the @option{-i} option.
2198 @xref{Target Selection}, for more information.
2201 @itemx --demangle[=@var{style}]
2202 @cindex demangling in objdump
2203 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2204 Besides removing any initial underscore prepended by the system, this
2205 makes C++ function names readable. Different compilers have different
2206 mangling styles. The optional demangling style argument can be used to
2207 choose an appropriate demangling style for your compiler. @xref{c++filt},
2208 for more information on demangling.
2210 @item --recurse-limit
2211 @itemx --no-recurse-limit
2212 @itemx --recursion-limit
2213 @itemx --no-recursion-limit
2214 Enables or disables a limit on the amount of recursion performed
2215 whilst demangling strings. Since the name mangling formats allow for
2216 an inifinite level of recursion it is possible to create strings whose
2217 decoding will exhaust the amount of stack space available on the host
2218 machine, triggering a memory fault. The limit tries to prevent this
2219 from happening by restricting recursion to 2048 levels of nesting.
2221 The default is for this limit to be enabled, but disabling it may be
2222 necessary in order to demangle truly complicated names. Note however
2223 that if the recursion limit is disabled then stack exhaustion is
2224 possible and any bug reports about such an event will be rejected.
2228 Display debugging information. This attempts to parse STABS
2229 debugging format information stored in the file and print it out using
2230 a C like syntax. If no STABS debuging was found this option
2231 falls back on the @option{-W} option to print any DWARF information in
2235 @itemx --debugging-tags
2236 Like @option{-g}, but the information is generated in a format compatible
2240 @itemx --disassemble
2241 @itemx --disassemble=@var{symbol}
2242 @cindex disassembling object code
2243 @cindex machine instructions
2244 Display the assembler mnemonics for the machine instructions from the
2245 input file. This option only disassembles those sections which are
2246 expected to contain instructions. If the optional @var{symbol}
2247 argument is given, then display the assembler mnemonics starting at
2248 @var{symbol}. If @var{symbol} is a function name then disassembly
2249 will stop at the end of the function, otherwise it will stop when the
2250 next symbol is encountered. If there are no matches for @var{symbol}
2251 then nothing will be displayed.
2253 Note if the @option{--dwarf=follow-links} option has also been enabled
2254 then any symbol tables in linked debug info files will be read in and
2255 used when disassembling.
2258 @itemx --disassemble-all
2259 Like @option{-d}, but disassemble the contents of all sections, not just
2260 those expected to contain instructions.
2262 This option also has a subtle effect on the disassembly of
2263 instructions in code sections. When option @option{-d} is in effect
2264 objdump will assume that any symbols present in a code section occur
2265 on the boundary between instructions and it will refuse to disassemble
2266 across such a boundary. When option @option{-D} is in effect however
2267 this assumption is supressed. This means that it is possible for the
2268 output of @option{-d} and @option{-D} to differ if, for example, data
2269 is stored in code sections.
2271 If the target is an ARM architecture this switch also has the effect
2272 of forcing the disassembler to decode pieces of data found in code
2273 sections as if they were instructions.
2275 Note if the @option{--dwarf=follow-links} option has also been enabled
2276 then any symbol tables in linked debug info files will be read in and
2277 used when disassembling.
2279 @item --prefix-addresses
2280 When disassembling, print the complete address on each line. This is
2281 the older disassembly format.
2285 @itemx --endian=@{big|little@}
2287 @cindex disassembly endianness
2288 Specify the endianness of the object files. This only affects
2289 disassembly. This can be useful when disassembling a file format which
2290 does not describe endianness information, such as S-records.
2293 @itemx --file-headers
2294 @cindex object file header
2295 Display summary information from the overall header of
2296 each of the @var{objfile} files.
2299 @itemx --file-offsets
2300 @cindex object file offsets
2301 When disassembling sections, whenever a symbol is displayed, also
2302 display the file offset of the region of data that is about to be
2303 dumped. If zeroes are being skipped, then when disassembly resumes,
2304 tell the user how many zeroes were skipped and the file offset of the
2305 location from where the disassembly resumes. When dumping sections,
2306 display the file offset of the location from where the dump starts.
2308 @item --file-start-context
2309 @cindex source code context
2310 Specify that when displaying interlisted source code/disassembly
2311 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2312 context to the start of the file.
2315 @itemx --section-headers
2317 @cindex section headers
2318 Display summary information from the section headers of the
2321 File segments may be relocated to nonstandard addresses, for example by
2322 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2323 @command{ld}. However, some object file formats, such as a.out, do not
2324 store the starting address of the file segments. In those situations,
2325 although @command{ld} relocates the sections correctly, using @samp{objdump
2326 -h} to list the file section headers cannot show the correct addresses.
2327 Instead, it shows the usual addresses, which are implicit for the
2330 Note, in some cases it is possible for a section to have both the
2331 READONLY and the NOREAD attributes set. In such cases the NOREAD
2332 attribute takes precedence, but @command{objdump} will report both
2333 since the exact setting of the flag bits might be important.
2337 Print a summary of the options to @command{objdump} and exit.
2341 @cindex architectures available
2342 @cindex object formats available
2343 Display a list showing all architectures and object formats available
2344 for specification with @option{-b} or @option{-m}.
2347 @itemx --section=@var{name}
2348 @cindex section information
2349 Display information only for section @var{name}.
2352 @itemx --line-numbers
2353 @cindex source filenames for object files
2354 Label the display (using debugging information) with the filename and
2355 source line numbers corresponding to the object code or relocs shown.
2356 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2358 @item -m @var{machine}
2359 @itemx --architecture=@var{machine}
2360 @cindex architecture
2361 @cindex disassembly architecture
2362 Specify the architecture to use when disassembling object files. This
2363 can be useful when disassembling object files which do not describe
2364 architecture information, such as S-records. You can list the available
2365 architectures with the @option{-i} option.
2367 If the target is an ARM architecture then this switch has an
2368 additional effect. It restricts the disassembly to only those
2369 instructions supported by the architecture specified by @var{machine}.
2370 If it is necessary to use this switch because the input file does not
2371 contain any architecture information, but it is also desired to
2372 disassemble all the instructions use @option{-marm}.
2374 @item -M @var{options}
2375 @itemx --disassembler-options=@var{options}
2376 Pass target specific information to the disassembler. Only supported on
2377 some targets. If it is necessary to specify more than one
2378 disassembler option then multiple @option{-M} options can be used or
2379 can be placed together into a comma separated list.
2381 For ARC, @option{dsp} controls the printing of DSP instructions,
2382 @option{spfp} selects the printing of FPX single precision FP
2383 instructions, @option{dpfp} selects the printing of FPX double
2384 precision FP instructions, @option{quarkse_em} selects the printing of
2385 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2386 of double precision assist instructions, @option{fpus} selects the
2387 printing of FPU single precision FP instructions, while @option{fpud}
2388 selects the printing of FPU double precision FP instructions.
2389 Additionally, one can choose to have all the immediates printed in
2390 hexadecimal using @option{hex}. By default, the short immediates are
2391 printed using the decimal representation, while the long immediate
2392 values are printed as hexadecimal.
2394 @option{cpu=...} allows to enforce a particular ISA when disassembling
2395 instructions, overriding the @option{-m} value or whatever is in the ELF file.
2396 This might be useful to select ARC EM or HS ISA, because architecture is same
2397 for those and disassembler relies on private ELF header data to decide if code
2398 is for EM or HS. This option might be specified multiple times - only the
2399 latest value will be used. Valid values are same as for the assembler
2400 @option{-mcpu=...} option.
2402 If the target is an ARM architecture then this switch can be used to
2403 select which register name set is used during disassembler. Specifying
2404 @option{-M reg-names-std} (the default) will select the register names as
2405 used in ARM's instruction set documentation, but with register 13 called
2406 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2407 @option{-M reg-names-apcs} will select the name set used by the ARM
2408 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2409 just use @samp{r} followed by the register number.
2411 There are also two variants on the APCS register naming scheme enabled
2412 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2413 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2414 with the normal register names or the special register names).
2416 This option can also be used for ARM architectures to force the
2417 disassembler to interpret all instructions as Thumb instructions by
2418 using the switch @option{--disassembler-options=force-thumb}. This can be
2419 useful when attempting to disassemble thumb code produced by other
2422 For AArch64 targets this switch can be used to set whether instructions are
2423 disassembled as the most general instruction using the @option{-M no-aliases}
2424 option or whether instruction notes should be generated as comments in the
2425 disasssembly using @option{-M notes}.
2427 For the x86, some of the options duplicate functions of the @option{-m}
2428 switch, but allow finer grained control. Multiple selections from the
2429 following may be specified as a comma separated string.
2434 Select disassembly for the given architecture.
2438 Select between intel syntax mode and AT&T syntax mode.
2442 Select between AMD64 ISA and Intel64 ISA.
2444 @item intel-mnemonic
2446 Select between intel mnemonic mode and AT&T mnemonic mode.
2447 Note: @code{intel-mnemonic} implies @code{intel} and
2448 @code{att-mnemonic} implies @code{att}.
2455 Specify the default address size and operand size. These five options
2456 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2457 appear later in the option string.
2460 When in AT&T mode, instructs the disassembler to print a mnemonic
2461 suffix even when the suffix could be inferred by the operands.
2464 For PowerPC, the @option{-M} argument @option{raw} selects
2465 disasssembly of hardware insns rather than aliases. For example, you
2466 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2467 rather than @code{li}. All of the @option{-m} arguments for
2468 @command{gas} that select a CPU are supported. These are:
2469 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2470 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2471 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2472 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2473 @option{booke32}, @option{cell}, @option{com}, @option{e200z4},
2474 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2475 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2476 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2477 @option{power8}, @option{power9}, @option{ppc}, @option{ppc32},
2478 @option{ppc64}, @option{ppc64bridge}, @option{ppcps}, @option{pwr},
2479 @option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2480 @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9},
2481 @option{pwrx}, @option{titan}, and @option{vle}.
2482 @option{32} and @option{64} modify the default or a prior CPU
2483 selection, disabling and enabling 64-bit insns respectively. In
2484 addition, @option{altivec}, @option{any}, @option{htm}, @option{vsx},
2485 and @option{spe} add capabilities to a previous @emph{or later} CPU
2486 selection. @option{any} will disassemble any opcode known to
2487 binutils, but in cases where an opcode has two different meanings or
2488 different arguments, you may not see the disassembly you expect.
2489 If you disassemble without giving a CPU selection, a default will be
2490 chosen from information gleaned by BFD from the object files headers,
2491 but the result again may not be as you expect.
2493 For MIPS, this option controls the printing of instruction mnemonic
2494 names and register names in disassembled instructions. Multiple
2495 selections from the following may be specified as a comma separated
2496 string, and invalid options are ignored:
2500 Print the 'raw' instruction mnemonic instead of some pseudo
2501 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2502 'sll' instead of 'nop', etc.
2505 Disassemble MSA instructions.
2508 Disassemble the virtualization ASE instructions.
2511 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2513 @item gpr-names=@var{ABI}
2514 Print GPR (general-purpose register) names as appropriate
2515 for the specified ABI. By default, GPR names are selected according to
2516 the ABI of the binary being disassembled.
2518 @item fpr-names=@var{ABI}
2519 Print FPR (floating-point register) names as
2520 appropriate for the specified ABI. By default, FPR numbers are printed
2523 @item cp0-names=@var{ARCH}
2524 Print CP0 (system control coprocessor; coprocessor 0) register names
2525 as appropriate for the CPU or architecture specified by
2526 @var{ARCH}. By default, CP0 register names are selected according to
2527 the architecture and CPU of the binary being disassembled.
2529 @item hwr-names=@var{ARCH}
2530 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2531 as appropriate for the CPU or architecture specified by
2532 @var{ARCH}. By default, HWR names are selected according to
2533 the architecture and CPU of the binary being disassembled.
2535 @item reg-names=@var{ABI}
2536 Print GPR and FPR names as appropriate for the selected ABI.
2538 @item reg-names=@var{ARCH}
2539 Print CPU-specific register names (CP0 register and HWR names)
2540 as appropriate for the selected CPU or architecture.
2543 For any of the options listed above, @var{ABI} or
2544 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2545 rather than names, for the selected types of registers.
2546 You can list the available values of @var{ABI} and @var{ARCH} using
2547 the @option{--help} option.
2549 For VAX, you can specify function entry addresses with @option{-M
2550 entry:0xf00ba}. You can use this multiple times to properly
2551 disassemble VAX binary files that don't contain symbol tables (like
2552 ROM dumps). In these cases, the function entry mask would otherwise
2553 be decoded as VAX instructions, which would probably lead the rest
2554 of the function being wrongly disassembled.
2557 @itemx --private-headers
2558 Print information that is specific to the object file format. The exact
2559 information printed depends upon the object file format. For some
2560 object file formats, no additional information is printed.
2562 @item -P @var{options}
2563 @itemx --private=@var{options}
2564 Print information that is specific to the object file format. The
2565 argument @var{options} is a comma separated list that depends on the
2566 format (the lists of options is displayed with the help).
2568 For XCOFF, the available options are:
2584 Not all object formats support this option. In particular the ELF
2585 format does not use it.
2589 @cindex relocation entries, in object file
2590 Print the relocation entries of the file. If used with @option{-d} or
2591 @option{-D}, the relocations are printed interspersed with the
2595 @itemx --dynamic-reloc
2596 @cindex dynamic relocation entries, in object file
2597 Print the dynamic relocation entries of the file. This is only
2598 meaningful for dynamic objects, such as certain types of shared
2599 libraries. As for @option{-r}, if used with @option{-d} or
2600 @option{-D}, the relocations are printed interspersed with the
2604 @itemx --full-contents
2605 @cindex sections, full contents
2606 @cindex object file sections
2607 Display the full contents of any sections requested. By default all
2608 non-empty sections are displayed.
2612 @cindex source disassembly
2613 @cindex disassembly, with source
2614 Display source code intermixed with disassembly, if possible. Implies
2617 @item --source-comment[=@var{txt}]
2618 @cindex source disassembly
2619 @cindex disassembly, with source
2620 Like the @option{-S} option, but all source code lines are displayed
2621 with a prefix of @var{txt}. Typically @var{txt} will be a comment
2622 string which can be used to distinguish the assembler code from the
2623 source code. If @var{txt} is not provided then a default string of
2624 @var{``# ``} (hash followed by a space), will be used.
2626 @item --prefix=@var{prefix}
2627 @cindex Add prefix to absolute paths
2628 Specify @var{prefix} to add to the absolute paths when used with
2631 @item --prefix-strip=@var{level}
2632 @cindex Strip absolute paths
2633 Indicate how many initial directory names to strip off the hardwired
2634 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2636 @item --show-raw-insn
2637 When disassembling instructions, print the instruction in hex as well as
2638 in symbolic form. This is the default except when
2639 @option{--prefix-addresses} is used.
2641 @item --no-show-raw-insn
2642 When disassembling instructions, do not print the instruction bytes.
2643 This is the default when @option{--prefix-addresses} is used.
2645 @item --insn-width=@var{width}
2646 @cindex Instruction width
2647 Display @var{width} bytes on a single line when disassembling
2650 @item -W[lLiaprmfFsoRtUuTgAckK]
2651 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2652 @include debug.options.texi
2655 Enable additional checks for consistency of Dwarf information.
2657 @include ctf.options.texi
2663 @cindex debug symbols
2664 @cindex ELF object file format
2665 Display the full contents of any sections requested. Display the
2666 contents of the .stab and .stab.index and .stab.excl sections from an
2667 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2668 @code{.stab} debugging symbol-table entries are carried in an ELF
2669 section. In most other file formats, debugging symbol-table entries are
2670 interleaved with linkage symbols, and are visible in the @option{--syms}
2673 @item --start-address=@var{address}
2674 @cindex start-address
2675 Start displaying data at the specified address. This affects the output
2676 of the @option{-d}, @option{-r} and @option{-s} options.
2678 @item --stop-address=@var{address}
2679 @cindex stop-address
2680 Stop displaying data at the specified address. This affects the output
2681 of the @option{-d}, @option{-r} and @option{-s} options.
2685 @cindex symbol table entries, printing
2686 Print the symbol table entries of the file.
2687 This is similar to the information provided by the @samp{nm} program,
2688 although the display format is different. The format of the output
2689 depends upon the format of the file being dumped, but there are two main
2690 types. One looks like this:
2693 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2694 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2697 where the number inside the square brackets is the number of the entry
2698 in the symbol table, the @var{sec} number is the section number, the
2699 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2700 symbol's type, the @var{scl} number is the symbol's storage class and
2701 the @var{nx} value is the number of auxilary entries associated with
2702 the symbol. The last two fields are the symbol's value and its name.
2704 The other common output format, usually seen with ELF based files,
2708 00000000 l d .bss 00000000 .bss
2709 00000000 g .text 00000000 fred
2712 Here the first number is the symbol's value (sometimes refered to as
2713 its address). The next field is actually a set of characters and
2714 spaces indicating the flag bits that are set on the symbol. These
2715 characters are described below. Next is the section with which the
2716 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2717 not connected with any section), or @emph{*UND*} if the section is
2718 referenced in the file being dumped, but not defined there.
2720 After the section name comes another field, a number, which for common
2721 symbols is the alignment and for other symbol is the size. Finally
2722 the symbol's name is displayed.
2724 The flag characters are divided into 7 groups as follows:
2730 The symbol is a local (l), global (g), unique global (u), neither
2731 global nor local (a space) or both global and local (!). A
2732 symbol can be neither local or global for a variety of reasons, e.g.,
2733 because it is used for debugging, but it is probably an indication of
2734 a bug if it is ever both local and global. Unique global symbols are
2735 a GNU extension to the standard set of ELF symbol bindings. For such
2736 a symbol the dynamic linker will make sure that in the entire process
2737 there is just one symbol with this name and type in use.
2740 The symbol is weak (w) or strong (a space).
2743 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2746 The symbol is a warning (W) or a normal symbol (a space). A warning
2747 symbol's name is a message to be displayed if the symbol following the
2748 warning symbol is ever referenced.
2752 The symbol is an indirect reference to another symbol (I), a function
2753 to be evaluated during reloc processing (i) or a normal symbol (a
2758 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2759 normal symbol (a space).
2764 The symbol is the name of a function (F) or a file (f) or an object
2765 (O) or just a normal symbol (a space).
2769 @itemx --dynamic-syms
2770 @cindex dynamic symbol table entries, printing
2771 Print the dynamic symbol table entries of the file. This is only
2772 meaningful for dynamic objects, such as certain types of shared
2773 libraries. This is similar to the information provided by the @samp{nm}
2774 program when given the @option{-D} (@option{--dynamic}) option.
2776 The output format is similar to that produced by the @option{--syms}
2777 option, except that an extra field is inserted before the symbol's
2778 name, giving the version information associated with the symbol.
2779 If the version is the default version to be used when resolving
2780 unversioned references to the symbol then it's displayed as is,
2781 otherwise it's put into parentheses.
2783 @item --special-syms
2784 When displaying symbols include those which the target considers to be
2785 special in some way and which would not normally be of interest to the
2790 Print the version number of @command{objdump} and exit.
2793 @itemx --all-headers
2794 @cindex all header information, object file
2795 @cindex header information, all
2796 Display all available header information, including the symbol table and
2797 relocation entries. Using @option{-x} is equivalent to specifying all of
2798 @option{-a -f -h -p -r -t}.
2802 @cindex wide output, printing
2803 Format some lines for output devices that have more than 80 columns.
2804 Also do not truncate symbol names when they are displayed.
2807 @itemx --disassemble-zeroes
2808 Normally the disassembly output will skip blocks of zeroes. This
2809 option directs the disassembler to disassemble those blocks, just like
2816 @c man begin SEEALSO objdump
2817 nm(1), readelf(1), and the Info entries for @file{binutils}.
2825 @cindex archive contents
2826 @cindex symbol index
2828 @c man title ranlib generate an index to an archive
2831 @c man begin SYNOPSIS ranlib
2832 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2836 @c man begin DESCRIPTION ranlib
2838 @command{ranlib} generates an index to the contents of an archive and
2839 stores it in the archive. The index lists each symbol defined by a
2840 member of an archive that is a relocatable object file.
2842 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2844 An archive with such an index speeds up linking to the library and
2845 allows routines in the library to call each other without regard to
2846 their placement in the archive.
2848 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2849 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2854 @c man begin OPTIONS ranlib
2860 Show usage information for @command{ranlib}.
2865 Show the version number of @command{ranlib}.
2868 @cindex deterministic archives
2869 @kindex --enable-deterministic-archives
2870 Operate in @emph{deterministic} mode. The symbol map archive member's
2871 header will show zero for the UID, GID, and timestamp. When this
2872 option is used, multiple runs will produce identical output files.
2874 If @file{binutils} was configured with
2875 @option{--enable-deterministic-archives}, then this mode is on by
2876 default. It can be disabled with the @samp{-U} option, described
2880 Update the timestamp of the symbol map of an archive.
2883 @cindex deterministic archives
2884 @kindex --enable-deterministic-archives
2885 Do @emph{not} operate in @emph{deterministic} mode. This is the
2886 inverse of the @samp{-D} option, above: the archive index will get
2887 actual UID, GID, timestamp, and file mode values.
2889 If @file{binutils} was configured @emph{without}
2890 @option{--enable-deterministic-archives}, then this mode is on by
2898 @c man begin SEEALSO ranlib
2899 ar(1), nm(1), and the Info entries for @file{binutils}.
2907 @cindex section sizes
2909 @c man title size list section sizes and total size of binary files
2912 @c man begin SYNOPSIS size
2913 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
2915 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2917 [@option{-t}|@option{--totals}]
2918 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2919 [@var{objfile}@dots{}]
2923 @c man begin DESCRIPTION size
2925 The @sc{gnu} @command{size} utility lists the section sizes and the total
2926 size for each of the binary files @var{objfile} on its argument list.
2927 By default, one line of output is generated for each file or each
2928 module if the file is an archive.
2930 @var{objfile}@dots{} are the files to be examined. If none are
2931 specified, the file @code{a.out} will be used instead.
2935 @c man begin OPTIONS size
2937 The command-line options have the following meanings:
2943 @itemx --format=@var{compatibility}
2944 @cindex @command{size} display format
2945 Using one of these options, you can choose whether the output from @sc{gnu}
2946 @command{size} resembles output from System V @command{size} (using @option{-A},
2947 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2948 @option{--format=berkeley}). The default is the one-line format similar to
2949 Berkeley's. Alternatively, you can choose the GNU format output
2950 (using @option{-G}, or @option{--format=gnu}), this is similar to
2951 Berkeley's output format, but sizes are counted differently.
2952 @c Bonus for doc-source readers: you can also say --format=strange (or
2953 @c anything else that starts with 's') for sysv, and --format=boring (or
2954 @c anything else that starts with 'b') for Berkeley.
2956 Here is an example of the Berkeley (default) format of output from
2959 $ size --format=Berkeley ranlib size
2960 text data bss dec hex filename
2961 294880 81920 11592 388392 5ed28 ranlib
2962 294880 81920 11888 388688 5ee50 size
2965 The Berkeley style output counts read only data in the @code{text}
2966 column, not in the @code{data} column, the @code{dec} and @code{hex}
2967 columns both display the sum of the @code{text}, @code{data}, and
2968 @code{bss} columns in decimal and hexadecimal respectively.
2970 The GNU format counts read only data in the @code{data} column, not
2971 the @code{text} column, and only displays the sum of the @code{text},
2972 @code{data}, and @code{bss} columns once, in the @code{total} column.
2973 The @option{--radix} option can be used to change the number base for
2974 all columns. Here is the same data displayed with GNU conventions:
2977 $ size --format=GNU ranlib size
2978 text data bss total filename
2979 279880 96920 11592 388392 ranlib
2980 279880 96920 11888 388688 size
2984 This is the same data, but displayed closer to System V conventions:
2987 $ size --format=SysV ranlib size
3005 Show a summary of acceptable arguments and options.
3010 @itemx --radix=@var{number}
3011 @cindex @command{size} number format
3012 @cindex radix for section sizes
3013 Using one of these options, you can control whether the size of each
3014 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3015 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3016 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
3017 values (8, 10, 16) are supported. The total size is always given in two
3018 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3019 octal and hexadecimal if you're using @option{-o}.
3022 Print total size of common symbols in each file. When using Berkeley
3023 or GNU format these are included in the bss size.
3027 Show totals of all objects listed (Berkeley or GNU format mode only).
3029 @item --target=@var{bfdname}
3030 @cindex object code format
3031 Specify that the object-code format for @var{objfile} is
3032 @var{bfdname}. This option may not be necessary; @command{size} can
3033 automatically recognize many formats.
3034 @xref{Target Selection}, for more information.
3038 Display the version number of @command{size}.
3044 @c man begin SEEALSO size
3045 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3052 @cindex listings strings
3053 @cindex printing strings
3054 @cindex strings, printing
3056 @c man title strings print the sequences of printable characters in files
3059 @c man begin SYNOPSIS strings
3060 strings [@option{-afovV}] [@option{-}@var{min-len}]
3061 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3062 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3063 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3064 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3065 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3066 [@option{-w}] [@option{--include-all-whitespace}]
3067 [@option{-s}] [@option{--output-separator}@var{sep_string}]
3068 [@option{--help}] [@option{--version}] @var{file}@dots{}
3072 @c man begin DESCRIPTION strings
3074 For each @var{file} given, @sc{gnu} @command{strings} prints the
3075 printable character sequences that are at least 4 characters long (or
3076 the number given with the options below) and are followed by an
3077 unprintable character.
3079 Depending upon how the strings program was configured it will default
3080 to either displaying all the printable sequences that it can find in
3081 each file, or only those sequences that are in loadable, initialized
3082 data sections. If the file type in unrecognizable, or if strings is
3083 reading from stdin then it will always display all of the printable
3084 sequences that it can find.
3086 For backwards compatibility any file that occurs after a command-line
3087 option of just @option{-} will also be scanned in full, regardless of
3088 the presence of any @option{-d} option.
3090 @command{strings} is mainly useful for determining the contents of
3095 @c man begin OPTIONS strings
3101 Scan the whole file, regardless of what sections it contains or
3102 whether those sections are loaded or initialized. Normally this is
3103 the default behaviour, but strings can be configured so that the
3104 @option{-d} is the default instead.
3106 The @option{-} option is position dependent and forces strings to
3107 perform full scans of any file that is mentioned after the @option{-}
3108 on the command line, even if the @option{-d} option has been
3113 Only print strings from initialized, loaded data sections in the
3114 file. This may reduce the amount of garbage in the output, but it
3115 also exposes the strings program to any security flaws that may be
3116 present in the BFD library used to scan and load sections. Strings
3117 can be configured so that this option is the default behaviour. In
3118 such cases the @option{-a} option can be used to avoid using the BFD
3119 library and instead just print all of the strings found in the file.
3122 @itemx --print-file-name
3123 Print the name of the file before each string.
3126 Print a summary of the program usage on the standard output and exit.
3128 @item -@var{min-len}
3129 @itemx -n @var{min-len}
3130 @itemx --bytes=@var{min-len}
3131 Print sequences of characters that are at least @var{min-len} characters
3132 long, instead of the default 4.
3135 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3136 act like @samp{-t d} instead. Since we can not be compatible with both
3137 ways, we simply chose one.
3139 @item -t @var{radix}
3140 @itemx --radix=@var{radix}
3141 Print the offset within the file before each string. The single
3142 character argument specifies the radix of the offset---@samp{o} for
3143 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3145 @item -e @var{encoding}
3146 @itemx --encoding=@var{encoding}
3147 Select the character encoding of the strings that are to be found.
3148 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3149 characters (ASCII, ISO 8859, etc., default), @samp{S} =
3150 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3151 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3152 littleendian. Useful for finding wide character strings. (@samp{l}
3153 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3155 @item -T @var{bfdname}
3156 @itemx --target=@var{bfdname}
3157 @cindex object code format
3158 Specify an object code format other than your system's default format.
3159 @xref{Target Selection}, for more information.
3164 Print the program version number on the standard output and exit.
3167 @itemx --include-all-whitespace
3168 By default tab and space characters are included in the strings that
3169 are displayed, but other whitespace characters, such a newlines and
3170 carriage returns, are not. The @option{-w} option changes this so
3171 that all whitespace characters are considered to be part of a string.
3174 @itemx --output-separator
3175 By default, output strings are delimited by a new-line. This option
3176 allows you to supply any string to be used as the output record
3177 separator. Useful with --include-all-whitespace where strings
3178 may contain new-lines internally.
3184 @c man begin SEEALSO strings
3185 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3186 and the Info entries for @file{binutils}.
3194 @cindex removing symbols
3195 @cindex discarding symbols
3196 @cindex symbols, discarding
3198 @c man title strip discard symbols and other data from object files
3201 @c man begin SYNOPSIS strip
3202 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3203 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3204 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3205 [@option{-s}|@option{--strip-all}]
3206 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3207 [@option{--strip-dwo}]
3208 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3209 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3210 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3211 [@option{-w}|@option{--wildcard}]
3212 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3213 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3214 [@option{--remove-relocations=}@var{sectionpattern}]
3215 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3216 [@option{-D}|@option{--enable-deterministic-archives}]
3217 [@option{-U}|@option{--disable-deterministic-archives}]
3218 [@option{--keep-file-symbols}]
3219 [@option{--only-keep-debug}]
3220 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3221 [@option{--help}] [@option{--info}]
3222 @var{objfile}@dots{}
3226 @c man begin DESCRIPTION strip
3228 @sc{gnu} @command{strip} discards all symbols from object files
3229 @var{objfile}. The list of object files may include archives.
3230 At least one object file must be given.
3232 @command{strip} modifies the files named in its argument,
3233 rather than writing modified copies under different names.
3237 @c man begin OPTIONS strip
3240 @item -F @var{bfdname}
3241 @itemx --target=@var{bfdname}
3242 Treat the original @var{objfile} as a file with the object
3243 code format @var{bfdname}, and rewrite it in the same format.
3244 @xref{Target Selection}, for more information.
3247 Show a summary of the options to @command{strip} and exit.
3250 Display a list showing all architectures and object formats available.
3252 @item -I @var{bfdname}
3253 @itemx --input-target=@var{bfdname}
3254 Treat the original @var{objfile} as a file with the object
3255 code format @var{bfdname}.
3256 @xref{Target Selection}, for more information.
3258 @item -O @var{bfdname}
3259 @itemx --output-target=@var{bfdname}
3260 Replace @var{objfile} with a file in the output format @var{bfdname}.
3261 @xref{Target Selection}, for more information.
3263 @item -R @var{sectionname}
3264 @itemx --remove-section=@var{sectionname}
3265 Remove any section named @var{sectionname} from the output file, in
3266 addition to whatever sections would otherwise be removed. This
3267 option may be given more than once. Note that using this option
3268 inappropriately may make the output file unusable. The wildcard
3269 character @samp{*} may be given at the end of @var{sectionname}. If
3270 so, then any section starting with @var{sectionname} will be removed.
3272 If the first character of @var{sectionpattern} is the exclamation
3273 point (!) then matching sections will not be removed even if an
3274 earlier use of @option{--remove-section} on the same command line
3275 would otherwise remove it. For example:
3278 --remove-section=.text.* --remove-section=!.text.foo
3281 will remove all sections matching the pattern '.text.*', but will not
3282 remove the section '.text.foo'.
3284 @item --remove-relocations=@var{sectionpattern}
3285 Remove relocations from the output file for any section matching
3286 @var{sectionpattern}. This option may be given more than once. Note
3287 that using this option inappropriately may make the output file
3288 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3292 --remove-relocations=.text.*
3295 will remove the relocations for all sections matching the patter
3298 If the first character of @var{sectionpattern} is the exclamation
3299 point (!) then matching sections will not have their relocation
3300 removed even if an earlier use of @option{--remove-relocations} on the
3301 same command line would otherwise cause the relocations to be removed.
3305 --remove-relocations=.text.* --remove-relocations=!.text.foo
3308 will remove all relocations for sections matching the pattern
3309 '.text.*', but will not remove relocations for the section
3319 @itemx --strip-debug
3320 Remove debugging symbols only.
3323 Remove the contents of all DWARF .dwo sections, leaving the
3324 remaining debugging sections and all symbols intact.
3325 See the description of this option in the @command{objcopy} section
3326 for more information.
3328 @item --strip-unneeded
3329 Remove all symbols that are not needed for relocation processing.
3331 @item -K @var{symbolname}
3332 @itemx --keep-symbol=@var{symbolname}
3333 When stripping symbols, keep symbol @var{symbolname} even if it would
3334 normally be stripped. This option may be given more than once.
3337 @itemx --merge-notes
3338 @itemx --no-merge-notes
3339 For ELF files, attempt (or do not attempt) to reduce the size of any
3340 SHT_NOTE type sections by removing duplicate notes. The default is to
3341 attempt this reduction unless stripping debug or DWO information.
3343 @item -N @var{symbolname}
3344 @itemx --strip-symbol=@var{symbolname}
3345 Remove symbol @var{symbolname} from the source file. This option may be
3346 given more than once, and may be combined with strip options other than
3350 Put the stripped output in @var{file}, rather than replacing the
3351 existing file. When this argument is used, only one @var{objfile}
3352 argument may be specified.
3355 @itemx --preserve-dates
3356 Preserve the access and modification dates of the file.
3359 @itemx --enable-deterministic-archives
3360 @cindex deterministic archives
3361 @kindex --enable-deterministic-archives
3362 Operate in @emph{deterministic} mode. When copying archive members
3363 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3364 and use consistent file modes for all files.
3366 If @file{binutils} was configured with
3367 @option{--enable-deterministic-archives}, then this mode is on by default.
3368 It can be disabled with the @samp{-U} option, below.
3371 @itemx --disable-deterministic-archives
3372 @cindex deterministic archives
3373 @kindex --enable-deterministic-archives
3374 Do @emph{not} operate in @emph{deterministic} mode. This is the
3375 inverse of the @option{-D} option, above: when copying archive members
3376 and writing the archive index, use their actual UID, GID, timestamp,
3377 and file mode values.
3379 This is the default unless @file{binutils} was configured with
3380 @option{--enable-deterministic-archives}.
3384 Permit regular expressions in @var{symbolname}s used in other command
3385 line options. The question mark (?), asterisk (*), backslash (\) and
3386 square brackets ([]) operators can be used anywhere in the symbol
3387 name. If the first character of the symbol name is the exclamation
3388 point (!) then the sense of the switch is reversed for that symbol.
3395 would cause strip to only keep symbols that start with the letters
3396 ``fo'', but to discard the symbol ``foo''.
3399 @itemx --discard-all
3400 Remove non-global symbols.
3403 @itemx --discard-locals
3404 Remove compiler-generated local symbols.
3405 (These usually start with @samp{L} or @samp{.}.)
3407 @item --keep-file-symbols
3408 When stripping a file, perhaps with @option{--strip-debug} or
3409 @option{--strip-unneeded}, retain any symbols specifying source file names,
3410 which would otherwise get stripped.
3412 @item --only-keep-debug
3413 Strip a file, emptying the contents of any sections that would not be
3414 stripped by @option{--strip-debug} and leaving the debugging sections
3415 intact. In ELF files, this preserves all the note sections in the
3418 Note - the section headers of the stripped sections are preserved,
3419 including their sizes, but the contents of the section are discarded.
3420 The section headers are preserved so that other tools can match up the
3421 debuginfo file with the real executable, even if that executable has
3422 been relocated to a different address space.
3424 The intention is that this option will be used in conjunction with
3425 @option{--add-gnu-debuglink} to create a two part executable. One a
3426 stripped binary which will occupy less space in RAM and in a
3427 distribution and the second a debugging information file which is only
3428 needed if debugging abilities are required. The suggested procedure
3429 to create these files is as follows:
3432 @item Link the executable as normal. Assuming that it is called
3434 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3435 create a file containing the debugging info.
3436 @item Run @code{objcopy --strip-debug foo} to create a
3437 stripped executable.
3438 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3439 to add a link to the debugging info into the stripped executable.
3442 Note---the choice of @code{.dbg} as an extension for the debug info
3443 file is arbitrary. Also the @code{--only-keep-debug} step is
3444 optional. You could instead do this:
3447 @item Link the executable as normal.
3448 @item Copy @code{foo} to @code{foo.full}
3449 @item Run @code{strip --strip-debug foo}
3450 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3453 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3454 full executable. It does not have to be a file created by the
3455 @option{--only-keep-debug} switch.
3457 Note---this switch is only intended for use on fully linked files. It
3458 does not make sense to use it on object files where the debugging
3459 information may be incomplete. Besides the gnu_debuglink feature
3460 currently only supports the presence of one filename containing
3461 debugging information, not multiple filenames on a one-per-object-file
3466 Show the version number for @command{strip}.
3470 Verbose output: list all object files modified. In the case of
3471 archives, @samp{strip -v} lists all members of the archive.
3477 @c man begin SEEALSO strip
3478 the Info entries for @file{binutils}.
3482 @node c++filt, addr2line, strip, Top
3486 @cindex demangling C++ symbols
3488 @c man title cxxfilt demangle C++ and Java symbols
3491 @c man begin SYNOPSIS cxxfilt
3492 c++filt [@option{-_}|@option{--strip-underscore}]
3493 [@option{-n}|@option{--no-strip-underscore}]
3494 [@option{-p}|@option{--no-params}]
3495 [@option{-t}|@option{--types}]
3496 [@option{-i}|@option{--no-verbose}]
3497 [@option{-r}|@option{--no-recurse-limit}]
3498 [@option{-R}|@option{--recurse-limit}]
3499 [@option{-s} @var{format}|@option{--format=}@var{format}]
3500 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3504 @c man begin DESCRIPTION cxxfilt
3507 The C++ and Java languages provide function overloading, which means
3508 that you can write many functions with the same name, providing that
3509 each function takes parameters of different types. In order to be
3510 able to distinguish these similarly named functions C++ and Java
3511 encode them into a low-level assembler name which uniquely identifies
3512 each different version. This process is known as @dfn{mangling}. The
3514 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3515 MS-DOS this program is named @command{CXXFILT}.}
3516 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3517 names into user-level names so that they can be read.
3519 Every alphanumeric word (consisting of letters, digits, underscores,
3520 dollars, or periods) seen in the input is a potential mangled name.
3521 If the name decodes into a C++ name, the C++ name replaces the
3522 low-level name in the output, otherwise the original word is output.
3523 In this way you can pass an entire assembler source file, containing
3524 mangled names, through @command{c++filt} and see the same source file
3525 containing demangled names.
3527 You can also use @command{c++filt} to decipher individual symbols by
3528 passing them on the command line:
3531 c++filt @var{symbol}
3534 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3535 names from the standard input instead. All the results are printed on
3536 the standard output. The difference between reading names from the
3537 command line versus reading names from the standard input is that
3538 command-line arguments are expected to be just mangled names and no
3539 checking is performed to separate them from surrounding text. Thus
3546 will work and demangle the name to ``f()'' whereas:
3552 will not work. (Note the extra comma at the end of the mangled
3553 name which makes it invalid). This command however will work:
3556 echo _Z1fv, | c++filt -n
3559 and will display ``f(),'', i.e., the demangled name followed by a
3560 trailing comma. This behaviour is because when the names are read
3561 from the standard input it is expected that they might be part of an
3562 assembler source file where there might be extra, extraneous
3563 characters trailing after a mangled name. For example:
3566 .type _Z1fv, @@function
3571 @c man begin OPTIONS cxxfilt
3575 @itemx --strip-underscore
3576 On some systems, both the C and C++ compilers put an underscore in front
3577 of every name. For example, the C name @code{foo} gets the low-level
3578 name @code{_foo}. This option removes the initial underscore. Whether
3579 @command{c++filt} removes the underscore by default is target dependent.
3582 @itemx --no-strip-underscore
3583 Do not remove the initial underscore.
3587 When demangling the name of a function, do not display the types of
3588 the function's parameters.
3592 Attempt to demangle types as well as function names. This is disabled
3593 by default since mangled types are normally only used internally in
3594 the compiler, and they can be confused with non-mangled names. For example,
3595 a function called ``a'' treated as a mangled type name would be
3596 demangled to ``signed char''.
3600 Do not include implementation details (if any) in the demangled
3605 @itemx --recurse-limit
3606 @itemx --no-recurse-limit
3607 @itemx --recursion-limit
3608 @itemx --no-recursion-limit
3609 Enables or disables a limit on the amount of recursion performed
3610 whilst demangling strings. Since the name mangling formats allow for
3611 an inifinite level of recursion it is possible to create strings whose
3612 decoding will exhaust the amount of stack space available on the host
3613 machine, triggering a memory fault. The limit tries to prevent this
3614 from happening by restricting recursion to 2048 levels of nesting.
3616 The default is for this limit to be enabled, but disabling it may be
3617 necessary in order to demangle truly complicated names. Note however
3618 that if the recursion limit is disabled then stack exhaustion is
3619 possible and any bug reports about such an event will be rejected.
3621 The @option{-r} option is a synonym for the
3622 @option{--no-recurse-limit} option. The @option{-R} option is a
3623 synonym for the @option{--recurse-limit} option.
3625 @item -s @var{format}
3626 @itemx --format=@var{format}
3627 @command{c++filt} can decode various methods of mangling, used by
3628 different compilers. The argument to this option selects which
3633 Automatic selection based on executable (the default method)
3635 the one used by the @sc{gnu} C++ compiler (g++)
3637 the one used by the Lucid compiler (lcc)
3639 the one specified by the C++ Annotated Reference Manual
3641 the one used by the HP compiler (aCC)
3643 the one used by the EDG compiler
3645 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3647 the one used by the @sc{gnu} Java compiler (gcj)
3649 the one used by the @sc{gnu} Ada compiler (GNAT).
3653 Print a summary of the options to @command{c++filt} and exit.
3656 Print the version number of @command{c++filt} and exit.
3662 @c man begin SEEALSO cxxfilt
3663 the Info entries for @file{binutils}.
3668 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3669 user interface are subject to change in future releases. In particular,
3670 a command-line option may be required in the future to decode a name
3671 passed as an argument on the command line; in other words,
3674 c++filt @var{symbol}
3678 may in a future release become
3681 c++filt @var{option} @var{symbol}
3689 @cindex address to file name and line number
3691 @c man title addr2line convert addresses into file names and line numbers
3694 @c man begin SYNOPSIS addr2line
3695 addr2line [@option{-a}|@option{--addresses}]
3696 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3697 [@option{-C}|@option{--demangle}[=@var{style}]]
3698 [@option{-r}|@option{--no-recurse-limit}]
3699 [@option{-R}|@option{--recurse-limit}]
3700 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3701 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3702 [@option{-i}|@option{--inlines}]
3703 [@option{-p}|@option{--pretty-print}]
3704 [@option{-j}|@option{--section=}@var{name}]
3705 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3710 @c man begin DESCRIPTION addr2line
3712 @command{addr2line} translates addresses into file names and line numbers.
3713 Given an address in an executable or an offset in a section of a relocatable
3714 object, it uses the debugging information to figure out which file name and
3715 line number are associated with it.
3717 The executable or relocatable object to use is specified with the @option{-e}
3718 option. The default is the file @file{a.out}. The section in the relocatable
3719 object to use is specified with the @option{-j} option.
3721 @command{addr2line} has two modes of operation.
3723 In the first, hexadecimal addresses are specified on the command line,
3724 and @command{addr2line} displays the file name and line number for each
3727 In the second, @command{addr2line} reads hexadecimal addresses from
3728 standard input, and prints the file name and line number for each
3729 address on standard output. In this mode, @command{addr2line} may be used
3730 in a pipe to convert dynamically chosen addresses.
3732 The format of the output is @samp{FILENAME:LINENO}. By default
3733 each input address generates one line of output.
3735 Two options can generate additional lines before each
3736 @samp{FILENAME:LINENO} line (in that order).
3738 If the @option{-a} option is used then a line with the input address
3741 If the @option{-f} option is used, then a line with the
3742 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3743 containing the address.
3745 One option can generate additional lines after the
3746 @samp{FILENAME:LINENO} line.
3748 If the @option{-i} option is used and the code at the given address is
3749 present there because of inlining by the compiler then additional
3750 lines are displayed afterwards. One or two extra lines (if the
3751 @option{-f} option is used) are displayed for each inlined function.
3753 Alternatively if the @option{-p} option is used then each input
3754 address generates a single, long, output line containing the address,
3755 the function name, the file name and the line number. If the
3756 @option{-i} option has also been used then any inlined functions will
3757 be displayed in the same manner, but on separate lines, and prefixed
3758 by the text @samp{(inlined by)}.
3760 If the file name or function name can not be determined,
3761 @command{addr2line} will print two question marks in their place. If the
3762 line number can not be determined, @command{addr2line} will print 0.
3766 @c man begin OPTIONS addr2line
3768 The long and short forms of options, shown here as alternatives, are
3774 Display the address before the function name, file and line number
3775 information. The address is printed with a @samp{0x} prefix to easily
3778 @item -b @var{bfdname}
3779 @itemx --target=@var{bfdname}
3780 @cindex object code format
3781 Specify that the object-code format for the object files is
3785 @itemx --demangle[=@var{style}]
3786 @cindex demangling in objdump
3787 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3788 Besides removing any initial underscore prepended by the system, this
3789 makes C++ function names readable. Different compilers have different
3790 mangling styles. The optional demangling style argument can be used to
3791 choose an appropriate demangling style for your compiler. @xref{c++filt},
3792 for more information on demangling.
3794 @item -e @var{filename}
3795 @itemx --exe=@var{filename}
3796 Specify the name of the executable for which addresses should be
3797 translated. The default file is @file{a.out}.
3801 Display function names as well as file and line number information.
3805 Display only the base of each file name.
3809 If the address belongs to a function that was inlined, the source
3810 information for all enclosing scopes back to the first non-inlined
3811 function will also be printed. For example, if @code{main} inlines
3812 @code{callee1} which inlines @code{callee2}, and address is from
3813 @code{callee2}, the source information for @code{callee1} and @code{main}
3814 will also be printed.
3818 Read offsets relative to the specified section instead of absolute addresses.
3821 @itemx --pretty-print
3822 Make the output more human friendly: each location are printed on one line.
3823 If option @option{-i} is specified, lines for all enclosing scopes are
3824 prefixed with @samp{(inlined by)}.
3828 @itemx --recurse-limit
3829 @itemx --no-recurse-limit
3830 @itemx --recursion-limit
3831 @itemx --no-recursion-limit
3832 Enables or disables a limit on the amount of recursion performed
3833 whilst demangling strings. Since the name mangling formats allow for
3834 an inifinite level of recursion it is possible to create strings whose
3835 decoding will exhaust the amount of stack space available on the host
3836 machine, triggering a memory fault. The limit tries to prevent this
3837 from happening by restricting recursion to 2048 levels of nesting.
3839 The default is for this limit to be enabled, but disabling it may be
3840 necessary in order to demangle truly complicated names. Note however
3841 that if the recursion limit is disabled then stack exhaustion is
3842 possible and any bug reports about such an event will be rejected.
3844 The @option{-r} option is a synonym for the
3845 @option{--no-recurse-limit} option. The @option{-R} option is a
3846 synonym for the @option{--recurse-limit} option.
3848 Note this option is only effective if the @option{-C} or
3849 @option{--demangle} option has been enabled.
3856 @c man begin SEEALSO addr2line
3857 Info entries for @file{binutils}.
3864 @command{windmc} may be used to generator Windows message resources.
3867 @emph{Warning:} @command{windmc} is not always built as part of the binary
3868 utilities, since it is only useful for Windows targets.
3871 @c man title windmc generates Windows message resources
3874 @c man begin SYNOPSIS windmc
3875 windmc [options] input-file
3879 @c man begin DESCRIPTION windmc
3881 @command{windmc} reads message definitions from an input file (.mc) and
3882 translate them into a set of output files. The output files may be of
3887 A C header file containing the message definitions.
3890 A resource file compilable by the @command{windres} tool.
3893 One or more binary files containing the resource data for a specific
3897 A C include file that maps message id's to their symbolic name.
3900 The exact description of these different formats is available in
3901 documentation from Microsoft.
3903 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3904 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3905 Windows Message Compiler.
3909 @c man begin OPTIONS windmc
3914 Specifies that the input file specified is ASCII. This is the default
3919 Specifies that messages in the output @code{bin} files should be in ASCII
3924 Specifies that @code{bin} filenames should have to be prefixed by the
3925 basename of the source file.
3929 Sets the customer bit in all message id's.
3931 @item -C @var{codepage}
3932 @itemx --codepage_in @var{codepage}
3933 Sets the default codepage to be used to convert input file to UTF16. The
3934 default is ocdepage 1252.
3937 @itemx --decimal_values
3938 Outputs the constants in the header file in decimal. Default is using
3942 @itemx --extension @var{ext}
3943 The extension for the header file. The default is .h extension.
3945 @item -F @var{target}
3946 @itemx --target @var{target}
3947 Specify the BFD format to use for a bin file as output. This
3948 is a BFD target name; you can use the @option{--help} option to see a list
3949 of supported targets. Normally @command{windmc} will use the default
3950 format, which is the first one listed by the @option{--help} option.
3952 @ref{Target Selection}.
3956 @itemx --headerdir @var{path}
3957 The target directory of the generated header file. The default is the
3962 Displays a list of command-line options and then exits.
3964 @item -m @var{characters}
3965 @itemx --maxlength @var{characters}
3966 Instructs @command{windmc} to generate a warning if the length
3967 of any message exceeds the number specified.
3970 @itemx --nullterminate
3971 Terminate message text in @code{bin} files by zero. By default they are
3972 terminated by CR/LF.
3975 @itemx --hresult_use
3976 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3977 file, using HRESULT definitions. Status codes are used if the flag is not
3980 @item -O @var{codepage}
3981 @itemx --codepage_out @var{codepage}
3982 Sets the default codepage to be used to output text files. The default
3986 @itemx --rcdir @var{path}
3987 The target directory for the generated @code{rc} script and the generated
3988 @code{bin} files that the resource compiler script includes. The default
3989 is the current directory.
3993 Specifies that the input file is UTF16.
3996 @itemx --unicode_out
3997 Specifies that messages in the output @code{bin} file should be in UTF16
3998 format. This is the default behaviour.
4002 Enable verbose mode.
4006 Prints the version number for @command{windmc}.
4009 @itemx --xdgb @var{path}
4010 The path of the @code{dbg} C include file that maps message id's to the
4011 symbolic name. No such file is generated without specifying the switch.
4017 @c man begin SEEALSO windmc
4018 the Info entries for @file{binutils}.
4025 @command{windres} may be used to manipulate Windows resources.
4028 @emph{Warning:} @command{windres} is not always built as part of the binary
4029 utilities, since it is only useful for Windows targets.
4032 @c man title windres manipulate Windows resources
4035 @c man begin SYNOPSIS windres
4036 windres [options] [input-file] [output-file]
4040 @c man begin DESCRIPTION windres
4042 @command{windres} reads resources from an input file and copies them into
4043 an output file. Either file may be in one of three formats:
4047 A text format read by the Resource Compiler.
4050 A binary format generated by the Resource Compiler.
4053 A COFF object or executable.
4056 The exact description of these different formats is available in
4057 documentation from Microsoft.
4059 When @command{windres} converts from the @code{rc} format to the @code{res}
4060 format, it is acting like the Windows Resource Compiler. When
4061 @command{windres} converts from the @code{res} format to the @code{coff}
4062 format, it is acting like the Windows @code{CVTRES} program.
4064 When @command{windres} generates an @code{rc} file, the output is similar
4065 but not identical to the format expected for the input. When an input
4066 @code{rc} file refers to an external filename, an output @code{rc} file
4067 will instead include the file contents.
4069 If the input or output format is not specified, @command{windres} will
4070 guess based on the file name, or, for the input file, the file contents.
4071 A file with an extension of @file{.rc} will be treated as an @code{rc}
4072 file, a file with an extension of @file{.res} will be treated as a
4073 @code{res} file, and a file with an extension of @file{.o} or
4074 @file{.exe} will be treated as a @code{coff} file.
4076 If no output file is specified, @command{windres} will print the resources
4077 in @code{rc} format to standard output.
4079 The normal use is for you to write an @code{rc} file, use @command{windres}
4080 to convert it to a COFF object file, and then link the COFF file into
4081 your application. This will make the resources described in the
4082 @code{rc} file available to Windows.
4086 @c man begin OPTIONS windres
4089 @item -i @var{filename}
4090 @itemx --input @var{filename}
4091 The name of the input file. If this option is not used, then
4092 @command{windres} will use the first non-option argument as the input file
4093 name. If there are no non-option arguments, then @command{windres} will
4094 read from standard input. @command{windres} can not read a COFF file from
4097 @item -o @var{filename}
4098 @itemx --output @var{filename}
4099 The name of the output file. If this option is not used, then
4100 @command{windres} will use the first non-option argument, after any used
4101 for the input file name, as the output file name. If there is no
4102 non-option argument, then @command{windres} will write to standard output.
4103 @command{windres} can not write a COFF file to standard output. Note,
4104 for compatibility with @command{rc} the option @option{-fo} is also
4105 accepted, but its use is not recommended.
4107 @item -J @var{format}
4108 @itemx --input-format @var{format}
4109 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4110 @samp{coff}. If no input format is specified, @command{windres} will
4111 guess, as described above.
4113 @item -O @var{format}
4114 @itemx --output-format @var{format}
4115 The output format to generate. @var{format} may be @samp{res},
4116 @samp{rc}, or @samp{coff}. If no output format is specified,
4117 @command{windres} will guess, as described above.
4119 @item -F @var{target}
4120 @itemx --target @var{target}
4121 Specify the BFD format to use for a COFF file as input or output. This
4122 is a BFD target name; you can use the @option{--help} option to see a list
4123 of supported targets. Normally @command{windres} will use the default
4124 format, which is the first one listed by the @option{--help} option.
4126 @ref{Target Selection}.
4129 @item --preprocessor @var{program}
4130 When @command{windres} reads an @code{rc} file, it runs it through the C
4131 preprocessor first. This option may be used to specify the preprocessor
4132 to use, including any leading arguments. The default preprocessor
4133 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4135 @item --preprocessor-arg @var{option}
4136 When @command{windres} reads an @code{rc} file, it runs it through
4137 the C preprocessor first. This option may be used to specify additional
4138 text to be passed to preprocessor on its command line.
4139 This option can be used multiple times to add multiple options to the
4140 preprocessor command line.
4142 @item -I @var{directory}
4143 @itemx --include-dir @var{directory}
4144 Specify an include directory to use when reading an @code{rc} file.
4145 @command{windres} will pass this to the preprocessor as an @option{-I}
4146 option. @command{windres} will also search this directory when looking for
4147 files named in the @code{rc} file. If the argument passed to this command
4148 matches any of the supported @var{formats} (as described in the @option{-J}
4149 option), it will issue a deprecation warning, and behave just like the
4150 @option{-J} option. New programs should not use this behaviour. If a
4151 directory happens to match a @var{format}, simple prefix it with @samp{./}
4152 to disable the backward compatibility.
4154 @item -D @var{target}
4155 @itemx --define @var{sym}[=@var{val}]
4156 Specify a @option{-D} option to pass to the preprocessor when reading an
4159 @item -U @var{target}
4160 @itemx --undefine @var{sym}
4161 Specify a @option{-U} option to pass to the preprocessor when reading an
4165 Ignored for compatibility with rc.
4168 Enable verbose mode. This tells you what the preprocessor is if you
4172 @item --codepage @var{val}
4173 Specify the default codepage to use when reading an @code{rc} file.
4174 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4175 codepage code. The valid range is from zero up to 0xffff, but the
4176 validity of the codepage is host and configuration dependent.
4179 @item --language @var{val}
4180 Specify the default language to use when reading an @code{rc} file.
4181 @var{val} should be a hexadecimal language code. The low eight bits are
4182 the language, and the high eight bits are the sublanguage.
4184 @item --use-temp-file
4185 Use a temporary file to instead of using popen to read the output of
4186 the preprocessor. Use this option if the popen implementation is buggy
4187 on the host (eg., certain non-English language versions of Windows 95 and
4188 Windows 98 are known to have buggy popen where the output will instead
4191 @item --no-use-temp-file
4192 Use popen, not a temporary file, to read the output of the preprocessor.
4193 This is the default behaviour.
4197 Prints a usage summary.
4201 Prints the version number for @command{windres}.
4204 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4205 this will turn on parser debugging.
4211 @c man begin SEEALSO windres
4212 the Info entries for @file{binutils}.
4221 @command{dlltool} is used to create the files needed to create dynamic
4222 link libraries (DLLs) on systems which understand PE format image
4223 files such as Windows. A DLL contains an export table which contains
4224 information that the runtime loader needs to resolve references from a
4225 referencing program.
4227 The export table is generated by this program by reading in a
4228 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4229 will be in the DLL. A @file{.o} file can contain information in
4230 special @samp{.drectve} sections with export information.
4233 @emph{Note:} @command{dlltool} is not always built as part of the
4234 binary utilities, since it is only useful for those targets which
4238 @c man title dlltool create files needed to build and use DLLs
4241 @c man begin SYNOPSIS dlltool
4242 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4243 [@option{-b}|@option{--base-file} @var{base-file-name}]
4244 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4245 [@option{-z}|@option{--output-def} @var{def-file-name}]
4246 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4247 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4248 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4249 [@option{--exclude-symbols} @var{list}]
4250 [@option{--no-default-excludes}]
4251 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4252 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4253 [@option{-a}|@option{--add-indirect}]
4254 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4255 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4256 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4257 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4258 [@option{--use-nul-prefixed-import-tables}]
4259 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4260 [@option{-i}|@option{--interwork}]
4261 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4262 [@option{-v}|@option{--verbose}]
4263 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4264 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4265 [object-file @dots{}]
4269 @c man begin DESCRIPTION dlltool
4271 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4272 @option{-b} options as well as object files specified on the command
4273 line. It then processes these inputs and if the @option{-e} option has
4274 been specified it creates a exports file. If the @option{-l} option
4275 has been specified it creates a library file and if the @option{-z} option
4276 has been specified it creates a def file. Any or all of the @option{-e},
4277 @option{-l} and @option{-z} options can be present in one invocation of
4280 When creating a DLL, along with the source for the DLL, it is necessary
4281 to have three other files. @command{dlltool} can help with the creation of
4284 The first file is a @file{.def} file which specifies which functions are
4285 exported from the DLL, which functions the DLL imports, and so on. This
4286 is a text file and can be created by hand, or @command{dlltool} can be used
4287 to create it using the @option{-z} option. In this case @command{dlltool}
4288 will scan the object files specified on its command line looking for
4289 those functions which have been specially marked as being exported and
4290 put entries for them in the @file{.def} file it creates.
4292 In order to mark a function as being exported from a DLL, it needs to
4293 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4294 section of the object file. This can be done in C by using the
4298 asm (".section .drectve");
4299 asm (".ascii \"-export:my_func\"");
4301 int my_func (void) @{ @dots{} @}
4304 The second file needed for DLL creation is an exports file. This file
4305 is linked with the object files that make up the body of the DLL and it
4306 handles the interface between the DLL and the outside world. This is a
4307 binary file and it can be created by giving the @option{-e} option to
4308 @command{dlltool} when it is creating or reading in a @file{.def} file.
4310 The third file needed for DLL creation is the library file that programs
4311 will link with in order to access the functions in the DLL (an `import
4312 library'). This file can be created by giving the @option{-l} option to
4313 dlltool when it is creating or reading in a @file{.def} file.
4315 If the @option{-y} option is specified, dlltool generates a delay-import
4316 library that can be used instead of the normal import library to allow
4317 a program to link to the dll only as soon as an imported function is
4318 called for the first time. The resulting executable will need to be
4319 linked to the static delayimp library containing __delayLoadHelper2(),
4320 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4322 @command{dlltool} builds the library file by hand, but it builds the
4323 exports file by creating temporary files containing assembler statements
4324 and then assembling these. The @option{-S} command-line option can be
4325 used to specify the path to the assembler that dlltool will use,
4326 and the @option{-f} option can be used to pass specific flags to that
4327 assembler. The @option{-n} can be used to prevent dlltool from deleting
4328 these temporary assembler files when it is done, and if @option{-n} is
4329 specified twice then this will prevent dlltool from deleting the
4330 temporary object files it used to build the library.
4332 Here is an example of creating a DLL from a source file @samp{dll.c} and
4333 also creating a program (from an object file called @samp{program.o})
4338 dlltool -e exports.o -l dll.lib dll.o
4339 gcc dll.o exports.o -o dll.dll
4340 gcc program.o dll.lib -o program
4344 @command{dlltool} may also be used to query an existing import library
4345 to determine the name of the DLL to which it is associated. See the
4346 description of the @option{-I} or @option{--identify} option.
4350 @c man begin OPTIONS dlltool
4352 The command-line options have the following meanings:
4356 @item -d @var{filename}
4357 @itemx --input-def @var{filename}
4358 @cindex input .def file
4359 Specifies the name of a @file{.def} file to be read in and processed.
4361 @item -b @var{filename}
4362 @itemx --base-file @var{filename}
4364 Specifies the name of a base file to be read in and processed. The
4365 contents of this file will be added to the relocation section in the
4366 exports file generated by dlltool.
4368 @item -e @var{filename}
4369 @itemx --output-exp @var{filename}
4370 Specifies the name of the export file to be created by dlltool.
4372 @item -z @var{filename}
4373 @itemx --output-def @var{filename}
4374 Specifies the name of the @file{.def} file to be created by dlltool.
4376 @item -l @var{filename}
4377 @itemx --output-lib @var{filename}
4378 Specifies the name of the library file to be created by dlltool.
4380 @item -y @var{filename}
4381 @itemx --output-delaylib @var{filename}
4382 Specifies the name of the delay-import library file to be created by dlltool.
4384 @item --export-all-symbols
4385 Treat all global and weak defined symbols found in the input object
4386 files as symbols to be exported. There is a small list of symbols which
4387 are not exported by default; see the @option{--no-default-excludes}
4388 option. You may add to the list of symbols to not export by using the
4389 @option{--exclude-symbols} option.
4391 @item --no-export-all-symbols
4392 Only export symbols explicitly listed in an input @file{.def} file or in
4393 @samp{.drectve} sections in the input object files. This is the default
4394 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4395 attributes in the source code.
4397 @item --exclude-symbols @var{list}
4398 Do not export the symbols in @var{list}. This is a list of symbol names
4399 separated by comma or colon characters. The symbol names should not
4400 contain a leading underscore. This is only meaningful when
4401 @option{--export-all-symbols} is used.
4403 @item --no-default-excludes
4404 When @option{--export-all-symbols} is used, it will by default avoid
4405 exporting certain special symbols. The current list of symbols to avoid
4406 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4407 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4408 to go ahead and export these special symbols. This is only meaningful
4409 when @option{--export-all-symbols} is used.
4412 @itemx --as @var{path}
4413 Specifies the path, including the filename, of the assembler to be used
4414 to create the exports file.
4416 @item -f @var{options}
4417 @itemx --as-flags @var{options}
4418 Specifies any specific command-line options to be passed to the
4419 assembler when building the exports file. This option will work even if
4420 the @option{-S} option is not used. This option only takes one argument,
4421 and if it occurs more than once on the command line, then later
4422 occurrences will override earlier occurrences. So if it is necessary to
4423 pass multiple options to the assembler they should be enclosed in
4427 @itemx --dll-name @var{name}
4428 Specifies the name to be stored in the @file{.def} file as the name of
4429 the DLL when the @option{-e} option is used. If this option is not
4430 present, then the filename given to the @option{-e} option will be
4431 used as the name of the DLL.
4433 @item -m @var{machine}
4434 @itemx -machine @var{machine}
4435 Specifies the type of machine for which the library file should be
4436 built. @command{dlltool} has a built in default type, depending upon how
4437 it was created, but this option can be used to override that. This is
4438 normally only useful when creating DLLs for an ARM processor, when the
4439 contents of the DLL are actually encode using Thumb instructions.
4442 @itemx --add-indirect
4443 Specifies that when @command{dlltool} is creating the exports file it
4444 should add a section which allows the exported functions to be
4445 referenced without using the import library. Whatever the hell that
4449 @itemx --add-underscore
4450 Specifies that when @command{dlltool} is creating the exports file it
4451 should prepend an underscore to the names of @emph{all} exported symbols.
4453 @item --no-leading-underscore
4454 @item --leading-underscore
4455 Specifies whether standard symbol should be forced to be prefixed, or
4458 @item --add-stdcall-underscore
4459 Specifies that when @command{dlltool} is creating the exports file it
4460 should prepend an underscore to the names of exported @emph{stdcall}
4461 functions. Variable names and non-stdcall function names are not modified.
4462 This option is useful when creating GNU-compatible import libs for third
4463 party DLLs that were built with MS-Windows tools.
4467 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4468 of stdcall functions that will be imported from the DLL. This is
4469 useful when creating an import library for a DLL which exports stdcall
4470 functions but without the usual @samp{@@<number>} symbol name suffix.
4472 This does not change the naming of symbols provided by the import library
4473 to programs linked against it, but only the entries in the import table
4474 (ie the .idata section).
4477 @itemx --add-stdcall-alias
4478 Specifies that when @command{dlltool} is creating the exports file it
4479 should add aliases for stdcall symbols without @samp{@@ <number>}
4480 in addition to the symbols with @samp{@@ <number>}.
4483 @itemx --ext-prefix-alias @var{prefix}
4484 Causes @command{dlltool} to create external aliases for all DLL
4485 imports with the specified prefix. The aliases are created for both
4486 external and import symbols with no leading underscore.
4490 Specifies that when @command{dlltool} is creating the exports and library
4491 files it should omit the @code{.idata4} section. This is for compatibility
4492 with certain operating systems.
4494 @item --use-nul-prefixed-import-tables
4495 Specifies that when @command{dlltool} is creating the exports and library
4496 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4497 element. This emulates old gnu import library generation of
4498 @code{dlltool}. By default this option is turned off.
4502 Specifies that when @command{dlltool} is creating the exports and library
4503 files it should omit the @code{.idata5} section. This is for compatibility
4504 with certain operating systems.
4506 @item -I @var{filename}
4507 @itemx --identify @var{filename}
4508 Specifies that @command{dlltool} should inspect the import library
4509 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4510 of the associated DLL(s). This can be performed in addition to any
4511 other operations indicated by the other options and arguments.
4512 @command{dlltool} fails if the import library does not exist or is not
4513 actually an import library. See also @option{--identify-strict}.
4515 @item --identify-strict
4516 Modifies the behavior of the @option{--identify} option, such
4517 that an error is reported if @var{filename} is associated with
4522 Specifies that @command{dlltool} should mark the objects in the library
4523 file and exports file that it produces as supporting interworking
4524 between ARM and Thumb code.
4528 Makes @command{dlltool} preserve the temporary assembler files it used to
4529 create the exports file. If this option is repeated then dlltool will
4530 also preserve the temporary object files it uses to create the library
4533 @item -t @var{prefix}
4534 @itemx --temp-prefix @var{prefix}
4535 Makes @command{dlltool} use @var{prefix} when constructing the names of
4536 temporary assembler and object files. By default, the temp file prefix
4537 is generated from the pid.
4541 Make dlltool describe what it is doing.
4545 Displays a list of command-line options and then exits.
4549 Displays dlltool's version number and then exits.
4556 * def file format:: The format of the dlltool @file{.def} file
4559 @node def file format
4560 @section The format of the @command{dlltool} @file{.def} file
4562 A @file{.def} file contains any number of the following commands:
4566 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4567 The result is going to be named @var{name}@code{.exe}.
4569 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4570 The result is going to be named @var{name}@code{.dll}.
4571 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4572 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4575 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4576 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4577 Declares @var{name1} as an exported symbol from the DLL, with optional
4578 ordinal number @var{integer}, or declares @var{name1} as an alias
4579 (forward) of the function @var{external-name} in the DLL.
4580 If @var{its_name} is specified, this name is used as string in export table.
4582 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4583 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4584 If you want to use LIBRARY as name then you need to quote it.
4586 @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{]} *}
4587 Declares that @var{external-name} or the exported function whose
4588 ordinal number is @var{integer} is to be imported from the file
4589 @var{module-name}. If @var{internal-name} is specified then this is
4590 the name that the imported function will be referred to in the body of
4592 If @var{its_name} is specified, this name is used as string in import table.
4593 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4594 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4595 If you want to use LIBRARY as name then you need to quote it.
4597 @item @code{DESCRIPTION} @var{string}
4598 Puts @var{string} into the output @file{.exp} file in the
4599 @code{.rdata} section.
4601 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4602 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4603 Generates @code{--stack} or @code{--heap}
4604 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4605 section. The linker will see this and act upon it.
4607 @item @code{CODE} @var{attr} @code{+}
4608 @item @code{DATA} @var{attr} @code{+}
4609 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4610 Generates @code{--attr} @var{section-name} @var{attr} in the output
4611 @code{.drectve} section, where @var{attr} is one of @code{READ},
4612 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4613 this and act upon it.
4618 @c man begin SEEALSO dlltool
4619 The Info pages for @file{binutils}.
4626 @cindex ELF file information
4629 @c man title readelf display information about ELF files
4632 @c man begin SYNOPSIS readelf
4633 readelf [@option{-a}|@option{--all}]
4634 [@option{-h}|@option{--file-header}]
4635 [@option{-l}|@option{--program-headers}|@option{--segments}]
4636 [@option{-S}|@option{--section-headers}|@option{--sections}]
4637 [@option{-g}|@option{--section-groups}]
4638 [@option{-t}|@option{--section-details}]
4639 [@option{-e}|@option{--headers}]
4640 [@option{-s}|@option{--syms}|@option{--symbols}]
4641 [@option{--dyn-syms}]
4642 [@option{-n}|@option{--notes}]
4643 [@option{-r}|@option{--relocs}]
4644 [@option{-u}|@option{--unwind}]
4645 [@option{-d}|@option{--dynamic}]
4646 [@option{-V}|@option{--version-info}]
4647 [@option{-A}|@option{--arch-specific}]
4648 [@option{-D}|@option{--use-dynamic}]
4649 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4650 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4651 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4652 [@option{-z}|@option{--decompress}]
4653 [@option{-c}|@option{--archive-index}]
4654 [@option{-w[lLiaprmfFsoRtUuTgAckK]}|
4655 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
4656 [@option{--dwarf-depth=@var{n}}]
4657 [@option{--dwarf-start=@var{n}}]
4658 [@option{--ctf=}@var{section}]
4659 [@option{--ctf-parent=}@var{section}]
4660 [@option{--ctf-symbols=}@var{section}]
4661 [@option{--ctf-strings=}@var{section}]
4662 [@option{-I}|@option{--histogram}]
4663 [@option{-v}|@option{--version}]
4664 [@option{-W}|@option{--wide}]
4665 [@option{-H}|@option{--help}]
4666 @var{elffile}@dots{}
4670 @c man begin DESCRIPTION readelf
4672 @command{readelf} displays information about one or more ELF format object
4673 files. The options control what particular information to display.
4675 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4676 64-bit ELF files are supported, as are archives containing ELF files.
4678 This program performs a similar function to @command{objdump} but it
4679 goes into more detail and it exists independently of the @sc{bfd}
4680 library, so if there is a bug in @sc{bfd} then readelf will not be
4685 @c man begin OPTIONS readelf
4687 The long and short forms of options, shown here as alternatives, are
4688 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4694 Equivalent to specifying @option{--file-header},
4695 @option{--program-headers}, @option{--sections}, @option{--symbols},
4696 @option{--relocs}, @option{--dynamic}, @option{--notes},
4697 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
4698 @option{--section-groups} and @option{--histogram}.
4700 Note - this option does not enable @option{--use-dynamic} itself, so
4701 if that option is not present on the command line then dynamic symbols
4702 and dynamic relocs will not be displayed.
4705 @itemx --file-header
4706 @cindex ELF file header information
4707 Displays the information contained in the ELF header at the start of the
4711 @itemx --program-headers
4713 @cindex ELF program header information
4714 @cindex ELF segment information
4715 Displays the information contained in the file's segment headers, if it
4720 @itemx --section-headers
4721 @cindex ELF section information
4722 Displays the information contained in the file's section headers, if it
4726 @itemx --section-groups
4727 @cindex ELF section group information
4728 Displays the information contained in the file's section groups, if it
4732 @itemx --section-details
4733 @cindex ELF section information
4734 Displays the detailed section information. Implies @option{-S}.
4739 @cindex ELF symbol table information
4740 Displays the entries in symbol table section of the file, if it has one.
4741 If a symbol has version information associated with it then this is
4742 displayed as well. The version string is displayed as a suffix to the
4743 symbol name, preceeded by an @@ character. For example
4744 @samp{foo@@VER_1}. If the version is the default version to be used
4745 when resolving unversioned references to the symbol then it is
4746 displayed as a suffix preceeded by two @@ characters. For example
4747 @samp{foo@@@@VER_2}.
4750 @cindex ELF dynamic symbol table information
4751 Displays the entries in dynamic symbol table section of the file, if it
4752 has one. The output format is the same as the format used by the
4753 @option{--syms} option.
4757 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4762 Displays the contents of the NOTE segments and/or sections, if any.
4766 @cindex ELF reloc information
4767 Displays the contents of the file's relocation section, if it has one.
4771 @cindex unwind information
4772 Displays the contents of the file's unwind section, if it has one. Only
4773 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4774 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. If
4775 support is not yet implemented for your architecture you could try
4776 dumping the contents of the @var{.eh_frames} section using the
4777 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
4782 @cindex ELF dynamic section information
4783 Displays the contents of the file's dynamic section, if it has one.
4786 @itemx --version-info
4787 @cindex ELF version sections information
4788 Displays the contents of the version sections in the file, it they
4792 @itemx --arch-specific
4793 Displays architecture-specific information in the file, if there
4797 @itemx --use-dynamic
4798 When displaying symbols, this option makes @command{readelf} use the
4799 symbol hash tables in the file's dynamic section, rather than the
4800 symbol table sections.
4802 When displaying relocations, this option makes @command{readelf}
4803 display the dynamic relocations rather than the static relocations.
4805 @item -x <number or name>
4806 @itemx --hex-dump=<number or name>
4807 Displays the contents of the indicated section as a hexadecimal bytes.
4808 A number identifies a particular section by index in the section table;
4809 any other string identifies all sections with that name in the object file.
4811 @item -R <number or name>
4812 @itemx --relocated-dump=<number or name>
4813 Displays the contents of the indicated section as a hexadecimal
4814 bytes. A number identifies a particular section by index in the
4815 section table; any other string identifies all sections with that name
4816 in the object file. The contents of the section will be relocated
4817 before they are displayed.
4819 @item -p <number or name>
4820 @itemx --string-dump=<number or name>
4821 Displays the contents of the indicated section as printable strings.
4822 A number identifies a particular section by index in the section table;
4823 any other string identifies all sections with that name in the object file.
4827 Requests that the section(s) being dumped by @option{x}, @option{R} or
4828 @option{p} options are decompressed before being displayed. If the
4829 section(s) are not compressed then they are displayed as is.
4832 @itemx --archive-index
4833 @cindex Archive file symbol index information
4834 Displays the file symbol index information contained in the header part
4835 of binary archives. Performs the same function as the @option{t}
4836 command to @command{ar}, but without using the BFD library. @xref{ar}.
4838 @item -w[lLiaprmfFsoRtUuTgAckK]
4839 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
4840 @include debug.options.texi
4842 @include ctf.options.texi
4843 @item --ctf-symbols=@var{section}
4844 @item --ctf-strings=@var{section}
4845 Specify the name of another section from which the CTF file can inherit
4846 strings and symbols.
4848 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
4849 other must be specified as well.
4853 Display a histogram of bucket list lengths when displaying the contents
4854 of the symbol tables.
4858 Display the version number of readelf.
4862 Don't break output lines to fit into 80 columns. By default
4863 @command{readelf} breaks section header and segment listing lines for
4864 64-bit ELF files, so that they fit into 80 columns. This option causes
4865 @command{readelf} to print each section header resp. each segment one a
4866 single line, which is far more readable on terminals wider than 80 columns.
4870 Display the command-line options understood by @command{readelf}.
4877 @c man begin SEEALSO readelf
4878 objdump(1), and the Info entries for @file{binutils}.
4885 @cindex Update ELF header
4888 @c man title elfedit update ELF header and program property of ELF files
4891 @c man begin SYNOPSIS elfedit
4892 elfedit [@option{--input-mach=}@var{machine}]
4893 [@option{--input-type=}@var{type}]
4894 [@option{--input-osabi=}@var{osabi}]
4895 @option{--output-mach=}@var{machine}
4896 @option{--output-type=}@var{type}
4897 @option{--output-osabi=}@var{osabi}
4898 @option{--enable-x86-feature=}@var{feature}
4899 @option{--disable-x86-feature=}@var{feature}
4900 [@option{-v}|@option{--version}]
4901 [@option{-h}|@option{--help}]
4902 @var{elffile}@dots{}
4906 @c man begin DESCRIPTION elfedit
4908 @command{elfedit} updates the ELF header and program property of ELF
4909 files which have the matching ELF machine and file types. The options
4910 control how and which fields in the ELF header and program property
4913 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4914 64-bit ELF files are supported, as are archives containing ELF files.
4917 @c man begin OPTIONS elfedit
4919 The long and short forms of options, shown here as alternatives, are
4920 equivalent. At least one of the @option{--output-mach},
4921 @option{--output-type}, @option{--output-osabi},
4922 @option{--enable-x86-feature} and @option{--disable-x86-feature}
4923 options must be given.
4927 @item --input-mach=@var{machine}
4928 Set the matching input ELF machine type to @var{machine}. If
4929 @option{--input-mach} isn't specified, it will match any ELF
4932 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4933 @var{K1OM} and @var{x86-64}.
4935 @item --output-mach=@var{machine}
4936 Change the ELF machine type in the ELF header to @var{machine}. The
4937 supported ELF machine types are the same as @option{--input-mach}.
4939 @item --input-type=@var{type}
4940 Set the matching input ELF file type to @var{type}. If
4941 @option{--input-type} isn't specified, it will match any ELF file types.
4943 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4945 @item --output-type=@var{type}
4946 Change the ELF file type in the ELF header to @var{type}. The
4947 supported ELF types are the same as @option{--input-type}.
4949 @item --input-osabi=@var{osabi}
4950 Set the matching input ELF file OSABI to @var{osabi}. If
4951 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4953 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4954 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4955 @var{Solaris}, @var{AIX}, @var{Irix},
4956 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4957 @var{NSK}, @var{AROS} and @var{FenixOS}.
4959 @item --output-osabi=@var{osabi}
4960 Change the ELF OSABI in the ELF header to @var{osabi}. The
4961 supported ELF OSABI are the same as @option{--input-osabi}.
4963 @item --enable-x86-feature=@var{feature}
4964 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
4965 ELF files with machine types of @var{i386} or @var{x86-64}. The
4966 supported features are, @var{ibt} and @var{shstk}.
4968 @item --disable-x86-feature=@var{feature}
4969 Clear the @var{feature} bit in program property in @var{exec} or
4970 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
4971 The supported features are the same as @option{--enable-x86-feature}.
4973 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
4974 are available only on hosts with @samp{mmap} support.
4978 Display the version number of @command{elfedit}.
4982 Display the command-line options understood by @command{elfedit}.
4989 @c man begin SEEALSO elfedit
4990 readelf(1), and the Info entries for @file{binutils}.
4994 @node Common Options
4995 @chapter Common Options
4997 The following command-line options are supported by all of the
4998 programs described in this manual.
5000 @c man begin OPTIONS
5002 @include at-file.texi
5006 Display the command-line options supported by the program.
5009 Display the version number of the program.
5011 @c man begin OPTIONS
5015 @node Selecting the Target System
5016 @chapter Selecting the Target System
5018 You can specify two aspects of the target system to the @sc{gnu}
5019 binary file utilities, each in several ways:
5029 In the following summaries, the lists of ways to specify values are in
5030 order of decreasing precedence. The ways listed first override those
5033 The commands to list valid values only list the values for which the
5034 programs you are running were configured. If they were configured with
5035 @option{--enable-targets=all}, the commands list most of the available
5036 values, but a few are left out; not all targets can be configured in at
5037 once because some of them can only be configured @dfn{native} (on hosts
5038 with the same type as the target system).
5041 * Target Selection::
5042 * Architecture Selection::
5045 @node Target Selection
5046 @section Target Selection
5048 A @dfn{target} is an object file format. A given target may be
5049 supported for multiple architectures (@pxref{Architecture Selection}).
5050 A target selection may also have variations for different operating
5051 systems or architectures.
5053 The command to list valid target values is @samp{objdump -i}
5054 (the first column of output contains the relevant information).
5056 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5057 @samp{a.out-sunos-big}.
5059 You can also specify a target using a configuration triplet. This is
5060 the same sort of name that is passed to @file{configure} to specify a
5061 target. When you use a configuration triplet as an argument, it must be
5062 fully canonicalized. You can see the canonical version of a triplet by
5063 running the shell script @file{config.sub} which is included with the
5066 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5067 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5069 @subheading @command{objdump} Target
5075 command-line option: @option{-b} or @option{--target}
5078 environment variable @code{GNUTARGET}
5081 deduced from the input file
5084 @subheading @command{objcopy} and @command{strip} Input Target
5090 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5093 environment variable @code{GNUTARGET}
5096 deduced from the input file
5099 @subheading @command{objcopy} and @command{strip} Output Target
5105 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5108 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5111 environment variable @code{GNUTARGET}
5114 deduced from the input file
5117 @subheading @command{nm}, @command{size}, and @command{strings} Target
5123 command-line option: @option{--target}
5126 environment variable @code{GNUTARGET}
5129 deduced from the input file
5132 @node Architecture Selection
5133 @section Architecture Selection
5135 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5136 to run. Its name may contain a colon, separating the name of the
5137 processor family from the name of the particular @sc{cpu}.
5139 The command to list valid architecture values is @samp{objdump -i} (the
5140 second column contains the relevant information).
5142 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5144 @subheading @command{objdump} Architecture
5150 command-line option: @option{-m} or @option{--architecture}
5153 deduced from the input file
5156 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5162 deduced from the input file
5165 @node Reporting Bugs
5166 @chapter Reporting Bugs
5168 @cindex reporting bugs
5170 Your bug reports play an essential role in making the binary utilities
5173 Reporting a bug may help you by bringing a solution to your problem, or
5174 it may not. But in any case the principal function of a bug report is
5175 to help the entire community by making the next version of the binary
5176 utilities work better. Bug reports are your contribution to their
5179 In order for a bug report to serve its purpose, you must include the
5180 information that enables us to fix the bug.
5183 * Bug Criteria:: Have you found a bug?
5184 * Bug Reporting:: How to report bugs
5188 @section Have You Found a Bug?
5189 @cindex bug criteria
5191 If you are not sure whether you have found a bug, here are some guidelines:
5194 @cindex fatal signal
5197 If a binary utility gets a fatal signal, for any input whatever, that is
5198 a bug. Reliable utilities never crash.
5200 @cindex error on valid input
5202 If a binary utility produces an error message for valid input, that is a
5206 If you are an experienced user of binary utilities, your suggestions for
5207 improvement are welcome in any case.
5211 @section How to Report Bugs
5213 @cindex bugs, reporting
5215 A number of companies and individuals offer support for @sc{gnu}
5216 products. If you obtained the binary utilities from a support
5217 organization, we recommend you contact that organization first.
5219 You can find contact information for many support companies and
5220 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5224 In any event, we also recommend that you send bug reports for the binary
5225 utilities to @value{BUGURL}.
5228 The fundamental principle of reporting bugs usefully is this:
5229 @strong{report all the facts}. If you are not sure whether to state a
5230 fact or leave it out, state it!
5232 Often people omit facts because they think they know what causes the
5233 problem and assume that some details do not matter. Thus, you might
5234 assume that the name of a file you use in an example does not matter.
5235 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5236 a stray memory reference which happens to fetch from the location where
5237 that pathname is stored in memory; perhaps, if the pathname were
5238 different, the contents of that location would fool the utility into
5239 doing the right thing despite the bug. Play it safe and give a
5240 specific, complete example. That is the easiest thing for you to do,
5241 and the most helpful.
5243 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5244 it is new to us. Therefore, always write your bug reports on the assumption
5245 that the bug has not been reported previously.
5247 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5248 bell?'' This cannot help us fix a bug, so it is basically useless. We
5249 respond by asking for enough details to enable us to investigate.
5250 You might as well expedite matters by sending them to begin with.
5252 To enable us to fix the bug, you should include all these things:
5256 The version of the utility. Each utility announces it if you start it
5257 with the @option{--version} argument.
5259 Without this, we will not know whether there is any point in looking for
5260 the bug in the current version of the binary utilities.
5263 Any patches you may have applied to the source, including any patches
5264 made to the @code{BFD} library.
5267 The type of machine you are using, and the operating system name and
5271 What compiler (and its version) was used to compile the utilities---e.g.
5275 The command arguments you gave the utility to observe the bug. To
5276 guarantee you will not omit something important, list them all. A copy
5277 of the Makefile (or the output from make) is sufficient.
5279 If we were to try to guess the arguments, we would probably guess wrong
5280 and then we might not encounter the bug.
5283 A complete input file, or set of input files, that will reproduce the
5284 bug. If the utility is reading an object file or files, then it is
5285 generally most helpful to send the actual object files.
5287 If the source files were produced exclusively using @sc{gnu} programs
5288 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5289 may be OK to send the source files rather than the object files. In
5290 this case, be sure to say exactly what version of @command{gcc}, or
5291 whatever, was used to produce the object files. Also say how
5292 @command{gcc}, or whatever, was configured.
5295 A description of what behavior you observe that you believe is
5296 incorrect. For example, ``It gets a fatal signal.''
5298 Of course, if the bug is that the utility gets a fatal signal, then we
5299 will certainly notice it. But if the bug is incorrect output, we might
5300 not notice unless it is glaringly wrong. You might as well not give us
5301 a chance to make a mistake.
5303 Even if the problem you experience is a fatal signal, you should still
5304 say so explicitly. Suppose something strange is going on, such as your
5305 copy of the utility is out of sync, or you have encountered a bug in
5306 the C library on your system. (This has happened!) Your copy might
5307 crash and ours would not. If you told us to expect a crash, then when
5308 ours fails to crash, we would know that the bug was not happening for
5309 us. If you had not told us to expect a crash, then we would not be able
5310 to draw any conclusion from our observations.
5313 If you wish to suggest changes to the source, send us context diffs, as
5314 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5315 option. Always send diffs from the old file to the new file. If you
5316 wish to discuss something in the @command{ld} source, refer to it by
5317 context, not by line number.
5319 The line numbers in our development sources will not match those in your
5320 sources. Your line numbers would convey no useful information to us.
5323 Here are some things that are not necessary:
5327 A description of the envelope of the bug.
5329 Often people who encounter a bug spend a lot of time investigating
5330 which changes to the input file will make the bug go away and which
5331 changes will not affect it.
5333 This is often time consuming and not very useful, because the way we
5334 will find the bug is by running a single example under the debugger
5335 with breakpoints, not by pure deduction from a series of examples.
5336 We recommend that you save your time for something else.
5338 Of course, if you can find a simpler example to report @emph{instead}
5339 of the original one, that is a convenience for us. Errors in the
5340 output will be easier to spot, running under the debugger will take
5341 less time, and so on.
5343 However, simplification is not vital; if you do not want to do this,
5344 report the bug anyway and send us the entire test case you used.
5347 A patch for the bug.
5349 A patch for the bug does help us if it is a good one. But do not omit
5350 the necessary information, such as the test case, on the assumption that
5351 a patch is all we need. We might see problems with your patch and decide
5352 to fix the problem another way, or we might not understand it at all.
5354 Sometimes with programs as complicated as the binary utilities it is
5355 very hard to construct an example that will make the program follow a
5356 certain path through the code. If you do not send us the example, we
5357 will not be able to construct one, so we will not be able to verify that
5360 And if we cannot understand what bug you are trying to fix, or why your
5361 patch should be an improvement, we will not install it. A test case will
5362 help us to understand.
5365 A guess about what the bug is or what it depends on.
5367 Such guesses are usually wrong. Even we cannot guess right about such
5368 things without first using the debugger to find the facts.
5371 @node GNU Free Documentation License
5372 @appendix GNU Free Documentation License
5376 @node Binutils Index
5377 @unnumbered Binutils Index