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{--set-section-alignment} @var{sectionpattern}=@var{align}]
1179 [@option{--add-section} @var{sectionname}=@var{filename}]
1180 [@option{--dump-section} @var{sectionname}=@var{filename}]
1181 [@option{--update-section} @var{sectionname}=@var{filename}]
1182 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1183 [@option{--long-section-names} @{enable,disable,keep@}]
1184 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1185 [@option{--reverse-bytes=}@var{num}]
1186 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1187 [@option{--redefine-sym} @var{old}=@var{new}]
1188 [@option{--redefine-syms=}@var{filename}]
1190 [@option{--keep-symbols=}@var{filename}]
1191 [@option{--strip-symbols=}@var{filename}]
1192 [@option{--strip-unneeded-symbols=}@var{filename}]
1193 [@option{--keep-global-symbols=}@var{filename}]
1194 [@option{--localize-symbols=}@var{filename}]
1195 [@option{--weaken-symbols=}@var{filename}]
1196 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]]
1197 [@option{--alt-machine-code=}@var{index}]
1198 [@option{--prefix-symbols=}@var{string}]
1199 [@option{--prefix-sections=}@var{string}]
1200 [@option{--prefix-alloc-sections=}@var{string}]
1201 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1202 [@option{--keep-file-symbols}]
1203 [@option{--only-keep-debug}]
1204 [@option{--strip-dwo}]
1205 [@option{--extract-dwo}]
1206 [@option{--extract-symbol}]
1207 [@option{--writable-text}]
1208 [@option{--readonly-text}]
1211 [@option{--file-alignment=}@var{num}]
1212 [@option{--heap=}@var{size}]
1213 [@option{--image-base=}@var{address}]
1214 [@option{--section-alignment=}@var{num}]
1215 [@option{--stack=}@var{size}]
1216 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1217 [@option{--compress-debug-sections}]
1218 [@option{--decompress-debug-sections}]
1219 [@option{--elf-stt-common=@var{val}}]
1220 [@option{--merge-notes}]
1221 [@option{--no-merge-notes}]
1222 [@option{--verilog-data-width=@var{val}}]
1223 [@option{-v}|@option{--verbose}]
1224 [@option{-V}|@option{--version}]
1225 [@option{--help}] [@option{--info}]
1226 @var{infile} [@var{outfile}]
1230 @c man begin DESCRIPTION objcopy
1231 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1232 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1233 read and write the object files. It can write the destination object
1234 file in a format different from that of the source object file. The
1235 exact behavior of @command{objcopy} is controlled by command-line options.
1236 Note that @command{objcopy} should be able to copy a fully linked file
1237 between any two formats. However, copying a relocatable object file
1238 between any two formats may not work as expected.
1240 @command{objcopy} creates temporary files to do its translations and
1241 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1242 translation work; it has access to all the formats described in @sc{bfd}
1243 and thus is able to recognize most formats without being told
1244 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1246 @command{objcopy} can be used to generate S-records by using an output
1247 target of @samp{srec} (e.g., use @samp{-O srec}).
1249 @command{objcopy} can be used to generate a raw binary file by using an
1250 output target of @samp{binary} (e.g., use @option{-O binary}). When
1251 @command{objcopy} generates a raw binary file, it will essentially produce
1252 a memory dump of the contents of the input object file. All symbols and
1253 relocation information will be discarded. The memory dump will start at
1254 the load address of the lowest section copied into the output file.
1256 When generating an S-record or a raw binary file, it may be helpful to
1257 use @option{-S} to remove sections containing debugging information. In
1258 some cases @option{-R} will be useful to remove sections which contain
1259 information that is not needed by the binary file.
1261 Note---@command{objcopy} is not able to change the endianness of its input
1262 files. If the input format has an endianness (some formats do not),
1263 @command{objcopy} can only copy the inputs into file formats that have the
1264 same endianness or which have no endianness (e.g., @samp{srec}).
1265 (However, see the @option{--reverse-bytes} option.)
1269 @c man begin OPTIONS objcopy
1273 @itemx @var{outfile}
1274 The input and output files, respectively.
1275 If you do not specify @var{outfile}, @command{objcopy} creates a
1276 temporary file and destructively renames the result with
1277 the name of @var{infile}.
1279 @item -I @var{bfdname}
1280 @itemx --input-target=@var{bfdname}
1281 Consider the source file's object format to be @var{bfdname}, rather than
1282 attempting to deduce it. @xref{Target Selection}, for more information.
1284 @item -O @var{bfdname}
1285 @itemx --output-target=@var{bfdname}
1286 Write the output file using the object format @var{bfdname}.
1287 @xref{Target Selection}, for more information.
1289 @item -F @var{bfdname}
1290 @itemx --target=@var{bfdname}
1291 Use @var{bfdname} as the object format for both the input and the output
1292 file; i.e., simply transfer data from source to destination with no
1293 translation. @xref{Target Selection}, for more information.
1295 @item -B @var{bfdarch}
1296 @itemx --binary-architecture=@var{bfdarch}
1297 Useful when transforming a architecture-less input file into an object file.
1298 In this case the output architecture can be set to @var{bfdarch}. This
1299 option will be ignored if the input file has a known @var{bfdarch}. You
1300 can access this binary data inside a program by referencing the special
1301 symbols that are created by the conversion process. These symbols are
1302 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1303 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1304 an object file and then access it in your code using these symbols.
1306 @item -j @var{sectionpattern}
1307 @itemx --only-section=@var{sectionpattern}
1308 Copy only the indicated sections from the input file to the output file.
1309 This option may be given more than once. Note that using this option
1310 inappropriately may make the output file unusable. Wildcard
1311 characters are accepted in @var{sectionpattern}.
1313 If the first character of @var{sectionpattern} is the exclamation
1314 point (!) then matching sections will not be copied, even if earlier
1315 use of @option{--only-section} on the same command line would
1316 otherwise copy it. For example:
1319 --only-section=.text.* --only-section=!.text.foo
1322 will copy all sectinos maching '.text.*' but not the section
1325 @item -R @var{sectionpattern}
1326 @itemx --remove-section=@var{sectionpattern}
1327 Remove any section matching @var{sectionpattern} from the output file.
1328 This option may be given more than once. Note that using this option
1329 inappropriately may make the output file unusable. Wildcard
1330 characters are accepted in @var{sectionpattern}. Using both the
1331 @option{-j} and @option{-R} options together results in undefined
1334 If the first character of @var{sectionpattern} is the exclamation
1335 point (!) then matching sections will not be removed even if an
1336 earlier use of @option{--remove-section} on the same command line
1337 would otherwise remove it. For example:
1340 --remove-section=.text.* --remove-section=!.text.foo
1343 will remove all sections matching the pattern '.text.*', but will not
1344 remove the section '.text.foo'.
1346 @item --remove-relocations=@var{sectionpattern}
1347 Remove non-dynamic relocations from the output file for any section
1348 matching @var{sectionpattern}. This option may be given more than
1349 once. Note that using this option inappropriately may make the output
1350 file unusable, and attempting to remove a dynamic relocation section
1351 such as @samp{.rela.plt} from an executable or shared library with
1352 @option{--remove-relocations=.plt} will not work. Wildcard characters
1353 are accepted in @var{sectionpattern}.
1357 --remove-relocations=.text.*
1360 will remove the relocations for all sections matching the pattern
1363 If the first character of @var{sectionpattern} is the exclamation
1364 point (!) then matching sections will not have their relocation
1365 removed even if an earlier use of @option{--remove-relocations} on the
1366 same command line would otherwise cause the relocations to be removed.
1370 --remove-relocations=.text.* --remove-relocations=!.text.foo
1373 will remove all relocations for sections matching the pattern
1374 '.text.*', but will not remove relocations for the section
1379 Do not copy relocation and symbol information from the source file.
1382 @itemx --strip-debug
1383 Do not copy debugging symbols or sections from the source file.
1385 @item --strip-unneeded
1386 Strip all symbols that are not needed for relocation processing.
1388 @item -K @var{symbolname}
1389 @itemx --keep-symbol=@var{symbolname}
1390 When stripping symbols, keep symbol @var{symbolname} even if it would
1391 normally be stripped. This option may be given more than once.
1393 @item -N @var{symbolname}
1394 @itemx --strip-symbol=@var{symbolname}
1395 Do not copy symbol @var{symbolname} from the source file. This option
1396 may be given more than once.
1398 @item --strip-unneeded-symbol=@var{symbolname}
1399 Do not copy symbol @var{symbolname} from the source file unless it is needed
1400 by a relocation. This option may be given more than once.
1402 @item -G @var{symbolname}
1403 @itemx --keep-global-symbol=@var{symbolname}
1404 Keep only symbol @var{symbolname} global. Make all other symbols local
1405 to the file, so that they are not visible externally. This option may
1406 be given more than once. Note: this option cannot be used in
1407 conjunction with the @option{--globalize-symbol} or
1408 @option{--globalize-symbols} options.
1410 @item --localize-hidden
1411 In an ELF object, mark all symbols that have hidden or internal visibility
1412 as local. This option applies on top of symbol-specific localization options
1413 such as @option{-L}.
1415 @item -L @var{symbolname}
1416 @itemx --localize-symbol=@var{symbolname}
1417 Convert a global or weak symbol called @var{symbolname} into a local
1418 symbol, so that it is not visible externally. This option may be
1419 given more than once. Note - unique symbols are not converted.
1421 @item -W @var{symbolname}
1422 @itemx --weaken-symbol=@var{symbolname}
1423 Make symbol @var{symbolname} weak. This option may be given more than once.
1425 @item --globalize-symbol=@var{symbolname}
1426 Give symbol @var{symbolname} global scoping so that it is visible
1427 outside of the file in which it is defined. This option may be given
1428 more than once. Note: this option cannot be used in conjunction with
1429 the @option{-G} or @option{--keep-global-symbol} options.
1433 Permit regular expressions in @var{symbolname}s used in other command
1434 line options. The question mark (?), asterisk (*), backslash (\) and
1435 square brackets ([]) operators can be used anywhere in the symbol
1436 name. If the first character of the symbol name is the exclamation
1437 point (!) then the sense of the switch is reversed for that symbol.
1444 would cause objcopy to weaken all symbols that start with ``fo''
1445 except for the symbol ``foo''.
1448 @itemx --discard-all
1449 Do not copy non-global symbols from the source file.
1450 @c FIXME any reason to prefer "non-global" to "local" here?
1453 @itemx --discard-locals
1454 Do not copy compiler-generated local symbols.
1455 (These usually start with @samp{L} or @samp{.}.)
1458 @itemx --byte=@var{byte}
1459 If interleaving has been enabled via the @option{--interleave} option
1460 then start the range of bytes to keep at the @var{byte}th byte.
1461 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1462 @var{breadth} is the value given by the @option{--interleave} option.
1464 @item -i [@var{breadth}]
1465 @itemx --interleave[=@var{breadth}]
1466 Only copy a range out of every @var{breadth} bytes. (Header data is
1467 not affected). Select which byte in the range begins the copy with
1468 the @option{--byte} option. Select the width of the range with the
1469 @option{--interleave-width} option.
1471 This option is useful for creating files to program @sc{rom}. It is
1472 typically used with an @code{srec} output target. Note that
1473 @command{objcopy} will complain if you do not specify the
1474 @option{--byte} option as well.
1476 The default interleave breadth is 4, so with @option{--byte} set to 0,
1477 @command{objcopy} would copy the first byte out of every four bytes
1478 from the input to the output.
1480 @item --interleave-width=@var{width}
1481 When used with the @option{--interleave} option, copy @var{width}
1482 bytes at a time. The start of the range of bytes to be copied is set
1483 by the @option{--byte} option, and the extent of the range is set with
1484 the @option{--interleave} option.
1486 The default value for this option is 1. The value of @var{width} plus
1487 the @var{byte} value set by the @option{--byte} option must not exceed
1488 the interleave breadth set by the @option{--interleave} option.
1490 This option can be used to create images for two 16-bit flashes interleaved
1491 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1492 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1493 commands. If the input was '12345678' then the outputs would be
1494 '1256' and '3478' respectively.
1497 @itemx --preserve-dates
1498 Set the access and modification dates of the output file to be the same
1499 as those of the input file.
1502 @itemx --enable-deterministic-archives
1503 @cindex deterministic archives
1504 @kindex --enable-deterministic-archives
1505 Operate in @emph{deterministic} mode. When copying archive members
1506 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1507 and use consistent file modes for all files.
1509 If @file{binutils} was configured with
1510 @option{--enable-deterministic-archives}, then this mode is on by default.
1511 It can be disabled with the @samp{-U} option, below.
1514 @itemx --disable-deterministic-archives
1515 @cindex deterministic archives
1516 @kindex --enable-deterministic-archives
1517 Do @emph{not} operate in @emph{deterministic} mode. This is the
1518 inverse of the @option{-D} option, above: when copying archive members
1519 and writing the archive index, use their actual UID, GID, timestamp,
1520 and file mode values.
1522 This is the default unless @file{binutils} was configured with
1523 @option{--enable-deterministic-archives}.
1526 Convert debugging information, if possible. This is not the default
1527 because only certain debugging formats are supported, and the
1528 conversion process can be time consuming.
1530 @item --gap-fill @var{val}
1531 Fill gaps between sections with @var{val}. This operation applies to
1532 the @emph{load address} (LMA) of the sections. It is done by increasing
1533 the size of the section with the lower address, and filling in the extra
1534 space created with @var{val}.
1536 @item --pad-to @var{address}
1537 Pad the output file up to the load address @var{address}. This is
1538 done by increasing the size of the last section. The extra space is
1539 filled in with the value specified by @option{--gap-fill} (default zero).
1541 @item --set-start @var{val}
1542 Set the start address of the new file to @var{val}. Not all object file
1543 formats support setting the start address.
1545 @item --change-start @var{incr}
1546 @itemx --adjust-start @var{incr}
1547 @cindex changing start address
1548 Change the start address by adding @var{incr}. Not all object file
1549 formats support setting the start address.
1551 @item --change-addresses @var{incr}
1552 @itemx --adjust-vma @var{incr}
1553 @cindex changing object addresses
1554 Change the VMA and LMA addresses of all sections, as well as the start
1555 address, by adding @var{incr}. Some object file formats do not permit
1556 section addresses to be changed arbitrarily. Note that this does not
1557 relocate the sections; if the program expects sections to be loaded at a
1558 certain address, and this option is used to change the sections such
1559 that they are loaded at a different address, the program may fail.
1561 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1562 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1563 @cindex changing section address
1564 Set or change both the VMA address and the LMA address of any section
1565 matching @var{sectionpattern}. If @samp{=} is used, the section
1566 address is set to @var{val}. Otherwise, @var{val} is added to or
1567 subtracted from the section address. See the comments under
1568 @option{--change-addresses}, above. If @var{sectionpattern} does not
1569 match any sections in the input file, a warning will be issued, unless
1570 @option{--no-change-warnings} is used.
1572 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1573 @cindex changing section LMA
1574 Set or change the LMA address of any sections matching
1575 @var{sectionpattern}. The LMA address is the address where the
1576 section will be loaded into memory at program load time. Normally
1577 this is the same as the VMA address, which is the address of the
1578 section at program run time, but on some systems, especially those
1579 where a program is held in ROM, the two can be different. If @samp{=}
1580 is used, the section address is set to @var{val}. Otherwise,
1581 @var{val} is added to or subtracted from the section address. See the
1582 comments under @option{--change-addresses}, above. If
1583 @var{sectionpattern} does not match any sections in the input file, a
1584 warning will be issued, unless @option{--no-change-warnings} is used.
1586 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1587 @cindex changing section VMA
1588 Set or change the VMA address of any section matching
1589 @var{sectionpattern}. The VMA address is the address where the
1590 section will be located once the program has started executing.
1591 Normally this is the same as the LMA address, which is the address
1592 where the section will be loaded into memory, but on some systems,
1593 especially those where a program is held in ROM, the two can be
1594 different. If @samp{=} is used, the section address is set to
1595 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1596 section address. See the comments under @option{--change-addresses},
1597 above. If @var{sectionpattern} does not match any sections in the
1598 input file, a warning will be issued, unless
1599 @option{--no-change-warnings} is used.
1601 @item --change-warnings
1602 @itemx --adjust-warnings
1603 If @option{--change-section-address} or @option{--change-section-lma} or
1604 @option{--change-section-vma} is used, and the section pattern does not
1605 match any sections, issue a warning. This is the default.
1607 @item --no-change-warnings
1608 @itemx --no-adjust-warnings
1609 Do not issue a warning if @option{--change-section-address} or
1610 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1611 if the section pattern does not match any sections.
1613 @item --set-section-flags @var{sectionpattern}=@var{flags}
1614 Set the flags for any sections matching @var{sectionpattern}. The
1615 @var{flags} argument is a comma separated string of flag names. The
1616 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1617 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1618 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1619 for a section which does not have contents, but it is not meaningful
1620 to clear the @samp{contents} flag of a section which does have
1621 contents--just remove the section instead. Not all flags are
1622 meaningful for all object file formats.
1624 @item --set-section-alignment @var{sectionpattern}=@var{align}
1625 Set the alignment for any sections matching @var{sectionpattern}.
1626 @var{align} specifies the alignment in bytes and must be a power of
1627 two, i.e. 1, 2, 4, 8@dots{}.
1629 @item --add-section @var{sectionname}=@var{filename}
1630 Add a new section named @var{sectionname} while copying the file. The
1631 contents of the new section are taken from the file @var{filename}. The
1632 size of the section will be the size of the file. This option only
1633 works on file formats which can support sections with arbitrary names.
1634 Note - it may be necessary to use the @option{--set-section-flags}
1635 option to set the attributes of the newly created section.
1637 @item --dump-section @var{sectionname}=@var{filename}
1638 Place the contents of section named @var{sectionname} into the file
1639 @var{filename}, overwriting any contents that may have been there
1640 previously. This option is the inverse of @option{--add-section}.
1641 This option is similar to the @option{--only-section} option except
1642 that it does not create a formatted file, it just dumps the contents
1643 as raw binary data, without applying any relocations. The option can
1644 be specified more than once.
1646 @item --update-section @var{sectionname}=@var{filename}
1647 Replace the existing contents of a section named @var{sectionname}
1648 with the contents of file @var{filename}. The size of the section
1649 will be adjusted to the size of the file. The section flags for
1650 @var{sectionname} will be unchanged. For ELF format files the section
1651 to segment mapping will also remain unchanged, something which is not
1652 possible using @option{--remove-section} followed by
1653 @option{--add-section}. The option can be specified more than once.
1655 Note - it is possible to use @option{--rename-section} and
1656 @option{--update-section} to both update and rename a section from one
1657 command line. In this case, pass the original section name to
1658 @option{--update-section}, and the original and new section names to
1659 @option{--rename-section}.
1661 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1662 Add a new symbol named @var{name} while copying the file. This option may be
1663 specified multiple times. If the @var{section} is given, the symbol will be
1664 associated with and relative to that section, otherwise it will be an ABS
1665 symbol. Specifying an undefined section will result in a fatal error. There
1666 is no check for the value, it will be taken as specified. Symbol flags can
1667 be specified and not all flags will be meaningful for all object file
1668 formats. By default, the symbol will be global. The special flag
1669 'before=@var{othersym}' will insert the new symbol in front of the specified
1670 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1671 symbol table in the order they appear.
1673 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1674 Rename a section from @var{oldname} to @var{newname}, optionally
1675 changing the section's flags to @var{flags} in the process. This has
1676 the advantage over using a linker script to perform the rename in that
1677 the output stays as an object file and does not become a linked
1680 This option is particularly helpful when the input format is binary,
1681 since this will always create a section called .data. If for example,
1682 you wanted instead to create a section called .rodata containing binary
1683 data you could use the following command line to achieve it:
1686 objcopy -I binary -O <output_format> -B <architecture> \
1687 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1688 <input_binary_file> <output_object_file>
1691 @item --long-section-names @{enable,disable,keep@}
1692 Controls the handling of long section names when processing @code{COFF}
1693 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1694 is to preserve long section names if any are present in the input file.
1695 The @samp{enable} and @samp{disable} options forcibly enable or disable
1696 the use of long section names in the output object; when @samp{disable}
1697 is in effect, any long section names in the input object will be truncated.
1698 The @samp{enable} option will only emit long section names if any are
1699 present in the inputs; this is mostly the same as @samp{keep}, but it
1700 is left undefined whether the @samp{enable} option might force the
1701 creation of an empty string table in the output file.
1703 @item --change-leading-char
1704 Some object file formats use special characters at the start of
1705 symbols. The most common such character is underscore, which compilers
1706 often add before every symbol. This option tells @command{objcopy} to
1707 change the leading character of every symbol when it converts between
1708 object file formats. If the object file formats use the same leading
1709 character, this option has no effect. Otherwise, it will add a
1710 character, or remove a character, or change a character, as
1713 @item --remove-leading-char
1714 If the first character of a global symbol is a special symbol leading
1715 character used by the object file format, remove the character. The
1716 most common symbol leading character is underscore. This option will
1717 remove a leading underscore from all global symbols. This can be useful
1718 if you want to link together objects of different file formats with
1719 different conventions for symbol names. This is different from
1720 @option{--change-leading-char} because it always changes the symbol name
1721 when appropriate, regardless of the object file format of the output
1724 @item --reverse-bytes=@var{num}
1725 Reverse the bytes in a section with output contents. A section length must
1726 be evenly divisible by the value given in order for the swap to be able to
1727 take place. Reversing takes place before the interleaving is performed.
1729 This option is used typically in generating ROM images for problematic
1730 target systems. For example, on some target boards, the 32-bit words
1731 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1732 regardless of the CPU byte order. Depending on the programming model, the
1733 endianness of the ROM may need to be modified.
1735 Consider a simple file with a section containing the following eight
1736 bytes: @code{12345678}.
1738 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1739 output file would be ordered @code{21436587}.
1741 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1742 output file would be ordered @code{43218765}.
1744 By using @samp{--reverse-bytes=2} for the above example, followed by
1745 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1746 output file would be ordered @code{34127856}.
1748 @item --srec-len=@var{ival}
1749 Meaningful only for srec output. Set the maximum length of the Srecords
1750 being produced to @var{ival}. This length covers both address, data and
1753 @item --srec-forceS3
1754 Meaningful only for srec output. Avoid generation of S1/S2 records,
1755 creating S3-only record format.
1757 @item --redefine-sym @var{old}=@var{new}
1758 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1759 when one is trying link two things together for which you have no
1760 source, and there are name collisions.
1762 @item --redefine-syms=@var{filename}
1763 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1764 listed in the file @var{filename}. @var{filename} is simply a flat file,
1765 with one symbol pair per line. Line comments may be introduced by the hash
1766 character. This option may be given more than once.
1769 Change all global symbols in the file to be weak. This can be useful
1770 when building an object which will be linked against other objects using
1771 the @option{-R} option to the linker. This option is only effective when
1772 using an object file format which supports weak symbols.
1774 @item --keep-symbols=@var{filename}
1775 Apply @option{--keep-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-symbols=@var{filename}
1781 Apply @option{--strip-symbol} option to each symbol listed in the file
1782 @var{filename}. @var{filename} is simply a flat file, with one symbol
1783 name per line. Line comments may be introduced by the hash character.
1784 This option may be given more than once.
1786 @item --strip-unneeded-symbols=@var{filename}
1787 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1788 the 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 --keep-global-symbols=@var{filename}
1793 Apply @option{--keep-global-symbol} option to each symbol listed in the
1794 file @var{filename}. @var{filename} is simply a flat file, with one
1795 symbol name per line. Line comments may be introduced by the hash
1796 character. This option may be given more than once.
1798 @item --localize-symbols=@var{filename}
1799 Apply @option{--localize-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.
1804 @item --globalize-symbols=@var{filename}
1805 Apply @option{--globalize-symbol} option to each symbol listed in the file
1806 @var{filename}. @var{filename} is simply a flat file, with one symbol
1807 name per line. Line comments may be introduced by the hash character.
1808 This option may be given more than once. Note: this option cannot be
1809 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1812 @item --weaken-symbols=@var{filename}
1813 Apply @option{--weaken-symbol} option to each symbol listed in the file
1814 @var{filename}. @var{filename} is simply a flat file, with one symbol
1815 name per line. Line comments may be introduced by the hash character.
1816 This option may be given more than once.
1818 @item --alt-machine-code=@var{index}
1819 If the output architecture has alternate machine codes, use the
1820 @var{index}th code instead of the default one. This is useful in case
1821 a machine is assigned an official code and the tool-chain adopts the
1822 new code, but other applications still depend on the original code
1823 being used. For ELF based architectures if the @var{index}
1824 alternative does not exist then the value is treated as an absolute
1825 number to be stored in the e_machine field of the ELF header.
1827 @item --writable-text
1828 Mark the output text as writable. This option isn't meaningful for all
1829 object file formats.
1831 @item --readonly-text
1832 Make the output text write protected. This option isn't meaningful for all
1833 object file formats.
1836 Mark the output file as demand paged. This option isn't meaningful for all
1837 object file formats.
1840 Mark the output file as impure. This option isn't meaningful for all
1841 object file formats.
1843 @item --prefix-symbols=@var{string}
1844 Prefix all symbols in the output file with @var{string}.
1846 @item --prefix-sections=@var{string}
1847 Prefix all section names in the output file with @var{string}.
1849 @item --prefix-alloc-sections=@var{string}
1850 Prefix all the names of all allocated sections in the output file with
1853 @item --add-gnu-debuglink=@var{path-to-file}
1854 Creates a .gnu_debuglink section which contains a reference to
1855 @var{path-to-file} and adds it to the output file. Note: the file at
1856 @var{path-to-file} must exist. Part of the process of adding the
1857 .gnu_debuglink section involves embedding a checksum of the contents
1858 of the debug info file into the section.
1860 If the debug info file is built in one location but it is going to be
1861 installed at a later time into a different location then do not use
1862 the path to the installed location. The @option{--add-gnu-debuglink}
1863 option will fail because the installed file does not exist yet.
1864 Instead put the debug info file in the current directory and use the
1865 @option{--add-gnu-debuglink} option without any directory components,
1869 objcopy --add-gnu-debuglink=foo.debug
1872 At debug time the debugger will attempt to look for the separate debug
1873 info file in a set of known locations. The exact set of these
1874 locations varies depending upon the distribution being used, but it
1879 @item * The same directory as the executable.
1881 @item * A sub-directory of the directory containing the executable
1884 @item * A global debug directory such as /usr/lib/debug.
1887 As long as the debug info file has been installed into one of these
1888 locations before the debugger is run everything should work
1891 @item --keep-file-symbols
1892 When stripping a file, perhaps with @option{--strip-debug} or
1893 @option{--strip-unneeded}, retain any symbols specifying source file names,
1894 which would otherwise get stripped.
1896 @item --only-keep-debug
1897 Strip a file, removing contents of any sections that would not be
1898 stripped by @option{--strip-debug} and leaving the debugging sections
1899 intact. In ELF files, this preserves all note sections in the output.
1901 Note - the section headers of the stripped sections are preserved,
1902 including their sizes, but the contents of the section are discarded.
1903 The section headers are preserved so that other tools can match up the
1904 debuginfo file with the real executable, even if that executable has
1905 been relocated to a different address space.
1907 The intention is that this option will be used in conjunction with
1908 @option{--add-gnu-debuglink} to create a two part executable. One a
1909 stripped binary which will occupy less space in RAM and in a
1910 distribution and the second a debugging information file which is only
1911 needed if debugging abilities are required. The suggested procedure
1912 to create these files is as follows:
1915 @item Link the executable as normal. Assuming that it is called
1917 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1918 create a file containing the debugging info.
1919 @item Run @code{objcopy --strip-debug foo} to create a
1920 stripped executable.
1921 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1922 to add a link to the debugging info into the stripped executable.
1925 Note---the choice of @code{.dbg} as an extension for the debug info
1926 file is arbitrary. Also the @code{--only-keep-debug} step is
1927 optional. You could instead do this:
1930 @item Link the executable as normal.
1931 @item Copy @code{foo} to @code{foo.full}
1932 @item Run @code{objcopy --strip-debug foo}
1933 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1936 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1937 full executable. It does not have to be a file created by the
1938 @option{--only-keep-debug} switch.
1940 Note---this switch is only intended for use on fully linked files. It
1941 does not make sense to use it on object files where the debugging
1942 information may be incomplete. Besides the gnu_debuglink feature
1943 currently only supports the presence of one filename containing
1944 debugging information, not multiple filenames on a one-per-object-file
1948 Remove the contents of all DWARF .dwo sections, leaving the
1949 remaining debugging sections and all symbols intact.
1950 This option is intended for use by the compiler as part of
1951 the @option{-gsplit-dwarf} option, which splits debug information
1952 between the .o file and a separate .dwo file. The compiler
1953 generates all debug information in the same file, then uses
1954 the @option{--extract-dwo} option to copy the .dwo sections to
1955 the .dwo file, then the @option{--strip-dwo} option to remove
1956 those sections from the original .o file.
1959 Extract the contents of all DWARF .dwo sections. See the
1960 @option{--strip-dwo} option for more information.
1962 @item --file-alignment @var{num}
1963 Specify the file alignment. Sections in the file will always begin at
1964 file offsets which are multiples of this number. This defaults to
1966 [This option is specific to PE targets.]
1968 @item --heap @var{reserve}
1969 @itemx --heap @var{reserve},@var{commit}
1970 Specify the number of bytes of memory to reserve (and optionally commit)
1971 to be used as heap for this program.
1972 [This option is specific to PE targets.]
1974 @item --image-base @var{value}
1975 Use @var{value} as the base address of your program or dll. This is
1976 the lowest memory location that will be used when your program or dll
1977 is loaded. To reduce the need to relocate and improve performance of
1978 your dlls, each should have a unique base address and not overlap any
1979 other dlls. The default is 0x400000 for executables, and 0x10000000
1981 [This option is specific to PE targets.]
1983 @item --section-alignment @var{num}
1984 Sets the section alignment field in the PE header. Sections in memory
1985 will always begin at addresses which are a multiple of this number.
1987 [This option is specific to PE targets.]
1989 @item --stack @var{reserve}
1990 @itemx --stack @var{reserve},@var{commit}
1991 Specify the number of bytes of memory to reserve (and optionally commit)
1992 to be used as stack for this program.
1993 [This option is specific to PE targets.]
1995 @item --subsystem @var{which}
1996 @itemx --subsystem @var{which}:@var{major}
1997 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1998 Specifies the subsystem under which your program will execute. The
1999 legal values for @var{which} are @code{native}, @code{windows},
2000 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
2001 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
2002 the subsystem version also. Numeric values are also accepted for
2004 [This option is specific to PE targets.]
2006 @item --extract-symbol
2007 Keep the file's section flags and symbols but remove all section data.
2008 Specifically, the option:
2011 @item removes the contents of all sections;
2012 @item sets the size of every section to zero; and
2013 @item sets the file's start address to zero.
2016 This option is used to build a @file{.sym} file for a VxWorks kernel.
2017 It can also be a useful way of reducing the size of a @option{--just-symbols}
2020 @item --compress-debug-sections
2021 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2022 ELF ABI. Note - if compression would actually make a section
2023 @emph{larger}, then it is not compressed.
2025 @item --compress-debug-sections=none
2026 @itemx --compress-debug-sections=zlib
2027 @itemx --compress-debug-sections=zlib-gnu
2028 @itemx --compress-debug-sections=zlib-gabi
2029 For ELF files, these options control how DWARF debug sections are
2030 compressed. @option{--compress-debug-sections=none} is equivalent
2031 to @option{--decompress-debug-sections}.
2032 @option{--compress-debug-sections=zlib} and
2033 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2034 @option{--compress-debug-sections}.
2035 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
2036 sections using zlib. The debug sections are renamed to begin with
2037 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
2038 actually make a section @emph{larger}, then it is not compressed nor
2041 @item --decompress-debug-sections
2042 Decompress DWARF debug sections using zlib. The original section
2043 names of the compressed sections are restored.
2045 @item --elf-stt-common=yes
2046 @itemx --elf-stt-common=no
2047 For ELF files, these options control whether common symbols should be
2048 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2049 @option{--elf-stt-common=yes} converts common symbol type to
2050 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2051 type to @code{STT_OBJECT}.
2054 @itemx --no-merge-notes
2055 For ELF files, attempt (or do not attempt) to reduce the size of any
2056 SHT_NOTE type sections by removing duplicate notes.
2060 Show the version number of @command{objcopy}.
2062 @item --verilog-data-width=@var{bytes}
2063 For Verilog output, this options controls the number of bytes
2064 converted for each output data element. The input target controls the
2065 endianness of the conversion.
2069 Verbose output: list all object files modified. In the case of
2070 archives, @samp{objcopy -V} lists all members of the archive.
2073 Show a summary of the options to @command{objcopy}.
2076 Display a list showing all architectures and object formats available.
2082 @c man begin SEEALSO objcopy
2083 ld(1), objdump(1), and the Info entries for @file{binutils}.
2090 @cindex object file information
2093 @c man title objdump display information from object files
2096 @c man begin SYNOPSIS objdump
2097 objdump [@option{-a}|@option{--archive-headers}]
2098 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2099 [@option{-C}|@option{--demangle}[=@var{style}] ]
2100 [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2101 [@option{-D}|@option{--disassemble-all}]
2102 [@option{-z}|@option{--disassemble-zeroes}]
2103 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2104 [@option{-f}|@option{--file-headers}]
2105 [@option{-F}|@option{--file-offsets}]
2106 [@option{--file-start-context}]
2107 [@option{-g}|@option{--debugging}]
2108 [@option{-e}|@option{--debugging-tags}]
2109 [@option{-h}|@option{--section-headers}|@option{--headers}]
2110 [@option{-i}|@option{--info}]
2111 [@option{-j} @var{section}|@option{--section=}@var{section}]
2112 [@option{-l}|@option{--line-numbers}]
2113 [@option{-S}|@option{--source}]
2114 [@option{--source-comment}[=@var{text}]]
2115 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2116 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2117 [@option{-p}|@option{--private-headers}]
2118 [@option{-P} @var{options}|@option{--private=}@var{options}]
2119 [@option{-r}|@option{--reloc}]
2120 [@option{-R}|@option{--dynamic-reloc}]
2121 [@option{-s}|@option{--full-contents}]
2122 [@option{-W[lLiaprmfFsoRtUuTgAckK]}|
2123 @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]]
2124 [@option{--ctf=}@var{section}]
2125 [@option{-G}|@option{--stabs}]
2126 [@option{-t}|@option{--syms}]
2127 [@option{-T}|@option{--dynamic-syms}]
2128 [@option{-x}|@option{--all-headers}]
2129 [@option{-w}|@option{--wide}]
2130 [@option{--start-address=}@var{address}]
2131 [@option{--stop-address=}@var{address}]
2132 [@option{--prefix-addresses}]
2133 [@option{--[no-]show-raw-insn}]
2134 [@option{--adjust-vma=}@var{offset}]
2135 [@option{--dwarf-depth=@var{n}}]
2136 [@option{--dwarf-start=@var{n}}]
2137 [@option{--ctf-parent=}@var{section}]
2138 [@option{--ctf-symbols=}@var{section}]
2139 [@option{--ctf-strings=}@var{section}]
2140 [@option{--no-recurse-limit}|@option{--recurse-limit}]
2141 [@option{--special-syms}]
2142 [@option{--prefix=}@var{prefix}]
2143 [@option{--prefix-strip=}@var{level}]
2144 [@option{--insn-width=}@var{width}]
2145 [@option{-V}|@option{--version}]
2146 [@option{-H}|@option{--help}]
2147 @var{objfile}@dots{}
2151 @c man begin DESCRIPTION objdump
2153 @command{objdump} displays information about one or more object files.
2154 The options control what particular information to display. This
2155 information is mostly useful to programmers who are working on the
2156 compilation tools, as opposed to programmers who just want their
2157 program to compile and work.
2159 @var{objfile}@dots{} are the object files to be examined. When you
2160 specify archives, @command{objdump} shows information on each of the member
2165 @c man begin OPTIONS objdump
2167 The long and short forms of options, shown here as alternatives, are
2168 equivalent. At least one option from the list
2169 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2173 @itemx --archive-header
2174 @cindex archive headers
2175 If any of the @var{objfile} files are archives, display the archive
2176 header information (in a format similar to @samp{ls -l}). Besides the
2177 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2178 the object file format of each archive member.
2180 @item --adjust-vma=@var{offset}
2181 @cindex section addresses in objdump
2182 @cindex VMA in objdump
2183 When dumping information, first add @var{offset} to all the section
2184 addresses. This is useful if the section addresses do not correspond to
2185 the symbol table, which can happen when putting sections at particular
2186 addresses when using a format which can not represent section addresses,
2189 @item -b @var{bfdname}
2190 @itemx --target=@var{bfdname}
2191 @cindex object code format
2192 Specify that the object-code format for the object files is
2193 @var{bfdname}. This option may not be necessary; @var{objdump} can
2194 automatically recognize many formats.
2198 objdump -b oasys -m vax -h fu.o
2201 displays summary information from the section headers (@option{-h}) of
2202 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2203 file in the format produced by Oasys compilers. You can list the
2204 formats available with the @option{-i} option.
2205 @xref{Target Selection}, for more information.
2208 @itemx --demangle[=@var{style}]
2209 @cindex demangling in objdump
2210 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2211 Besides removing any initial underscore prepended by the system, this
2212 makes C++ function names readable. Different compilers have different
2213 mangling styles. The optional demangling style argument can be used to
2214 choose an appropriate demangling style for your compiler. @xref{c++filt},
2215 for more information on demangling.
2217 @item --recurse-limit
2218 @itemx --no-recurse-limit
2219 @itemx --recursion-limit
2220 @itemx --no-recursion-limit
2221 Enables or disables a limit on the amount of recursion performed
2222 whilst demangling strings. Since the name mangling formats allow for
2223 an inifinite level of recursion it is possible to create strings whose
2224 decoding will exhaust the amount of stack space available on the host
2225 machine, triggering a memory fault. The limit tries to prevent this
2226 from happening by restricting recursion to 2048 levels of nesting.
2228 The default is for this limit to be enabled, but disabling it may be
2229 necessary in order to demangle truly complicated names. Note however
2230 that if the recursion limit is disabled then stack exhaustion is
2231 possible and any bug reports about such an event will be rejected.
2235 Display debugging information. This attempts to parse STABS
2236 debugging format information stored in the file and print it out using
2237 a C like syntax. If no STABS debuging was found this option
2238 falls back on the @option{-W} option to print any DWARF information in
2242 @itemx --debugging-tags
2243 Like @option{-g}, but the information is generated in a format compatible
2247 @itemx --disassemble
2248 @itemx --disassemble=@var{symbol}
2249 @cindex disassembling object code
2250 @cindex machine instructions
2251 Display the assembler mnemonics for the machine instructions from the
2252 input file. This option only disassembles those sections which are
2253 expected to contain instructions. If the optional @var{symbol}
2254 argument is given, then display the assembler mnemonics starting at
2255 @var{symbol}. If @var{symbol} is a function name then disassembly
2256 will stop at the end of the function, otherwise it will stop when the
2257 next symbol is encountered. If there are no matches for @var{symbol}
2258 then nothing will be displayed.
2260 Note if the @option{--dwarf=follow-links} option has also been enabled
2261 then any symbol tables in linked debug info files will be read in and
2262 used when disassembling.
2265 @itemx --disassemble-all
2266 Like @option{-d}, but disassemble the contents of all sections, not just
2267 those expected to contain instructions.
2269 This option also has a subtle effect on the disassembly of
2270 instructions in code sections. When option @option{-d} is in effect
2271 objdump will assume that any symbols present in a code section occur
2272 on the boundary between instructions and it will refuse to disassemble
2273 across such a boundary. When option @option{-D} is in effect however
2274 this assumption is supressed. This means that it is possible for the
2275 output of @option{-d} and @option{-D} to differ if, for example, data
2276 is stored in code sections.
2278 If the target is an ARM architecture this switch also has the effect
2279 of forcing the disassembler to decode pieces of data found in code
2280 sections as if they were instructions.
2282 Note if the @option{--dwarf=follow-links} option has also been enabled
2283 then any symbol tables in linked debug info files will be read in and
2284 used when disassembling.
2286 @item --prefix-addresses
2287 When disassembling, print the complete address on each line. This is
2288 the older disassembly format.
2292 @itemx --endian=@{big|little@}
2294 @cindex disassembly endianness
2295 Specify the endianness of the object files. This only affects
2296 disassembly. This can be useful when disassembling a file format which
2297 does not describe endianness information, such as S-records.
2300 @itemx --file-headers
2301 @cindex object file header
2302 Display summary information from the overall header of
2303 each of the @var{objfile} files.
2306 @itemx --file-offsets
2307 @cindex object file offsets
2308 When disassembling sections, whenever a symbol is displayed, also
2309 display the file offset of the region of data that is about to be
2310 dumped. If zeroes are being skipped, then when disassembly resumes,
2311 tell the user how many zeroes were skipped and the file offset of the
2312 location from where the disassembly resumes. When dumping sections,
2313 display the file offset of the location from where the dump starts.
2315 @item --file-start-context
2316 @cindex source code context
2317 Specify that when displaying interlisted source code/disassembly
2318 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2319 context to the start of the file.
2322 @itemx --section-headers
2324 @cindex section headers
2325 Display summary information from the section headers of the
2328 File segments may be relocated to nonstandard addresses, for example by
2329 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2330 @command{ld}. However, some object file formats, such as a.out, do not
2331 store the starting address of the file segments. In those situations,
2332 although @command{ld} relocates the sections correctly, using @samp{objdump
2333 -h} to list the file section headers cannot show the correct addresses.
2334 Instead, it shows the usual addresses, which are implicit for the
2337 Note, in some cases it is possible for a section to have both the
2338 READONLY and the NOREAD attributes set. In such cases the NOREAD
2339 attribute takes precedence, but @command{objdump} will report both
2340 since the exact setting of the flag bits might be important.
2344 Print a summary of the options to @command{objdump} and exit.
2348 @cindex architectures available
2349 @cindex object formats available
2350 Display a list showing all architectures and object formats available
2351 for specification with @option{-b} or @option{-m}.
2354 @itemx --section=@var{name}
2355 @cindex section information
2356 Display information only for section @var{name}.
2359 @itemx --line-numbers
2360 @cindex source filenames for object files
2361 Label the display (using debugging information) with the filename and
2362 source line numbers corresponding to the object code or relocs shown.
2363 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2365 @item -m @var{machine}
2366 @itemx --architecture=@var{machine}
2367 @cindex architecture
2368 @cindex disassembly architecture
2369 Specify the architecture to use when disassembling object files. This
2370 can be useful when disassembling object files which do not describe
2371 architecture information, such as S-records. You can list the available
2372 architectures with the @option{-i} option.
2374 If the target is an ARM architecture then this switch has an
2375 additional effect. It restricts the disassembly to only those
2376 instructions supported by the architecture specified by @var{machine}.
2377 If it is necessary to use this switch because the input file does not
2378 contain any architecture information, but it is also desired to
2379 disassemble all the instructions use @option{-marm}.
2381 @item -M @var{options}
2382 @itemx --disassembler-options=@var{options}
2383 Pass target specific information to the disassembler. Only supported on
2384 some targets. If it is necessary to specify more than one
2385 disassembler option then multiple @option{-M} options can be used or
2386 can be placed together into a comma separated list.
2388 For ARC, @option{dsp} controls the printing of DSP instructions,
2389 @option{spfp} selects the printing of FPX single precision FP
2390 instructions, @option{dpfp} selects the printing of FPX double
2391 precision FP instructions, @option{quarkse_em} selects the printing of
2392 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2393 of double precision assist instructions, @option{fpus} selects the
2394 printing of FPU single precision FP instructions, while @option{fpud}
2395 selects the printing of FPU double precision FP instructions.
2396 Additionally, one can choose to have all the immediates printed in
2397 hexadecimal using @option{hex}. By default, the short immediates are
2398 printed using the decimal representation, while the long immediate
2399 values are printed as hexadecimal.
2401 @option{cpu=...} allows to enforce a particular ISA when disassembling
2402 instructions, overriding the @option{-m} value or whatever is in the ELF file.
2403 This might be useful to select ARC EM or HS ISA, because architecture is same
2404 for those and disassembler relies on private ELF header data to decide if code
2405 is for EM or HS. This option might be specified multiple times - only the
2406 latest value will be used. Valid values are same as for the assembler
2407 @option{-mcpu=...} option.
2409 If the target is an ARM architecture then this switch can be used to
2410 select which register name set is used during disassembler. Specifying
2411 @option{-M reg-names-std} (the default) will select the register names as
2412 used in ARM's instruction set documentation, but with register 13 called
2413 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2414 @option{-M reg-names-apcs} will select the name set used by the ARM
2415 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2416 just use @samp{r} followed by the register number.
2418 There are also two variants on the APCS register naming scheme enabled
2419 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2420 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2421 with the normal register names or the special register names).
2423 This option can also be used for ARM architectures to force the
2424 disassembler to interpret all instructions as Thumb instructions by
2425 using the switch @option{--disassembler-options=force-thumb}. This can be
2426 useful when attempting to disassemble thumb code produced by other
2429 For AArch64 targets this switch can be used to set whether instructions are
2430 disassembled as the most general instruction using the @option{-M no-aliases}
2431 option or whether instruction notes should be generated as comments in the
2432 disasssembly using @option{-M notes}.
2434 For the x86, some of the options duplicate functions of the @option{-m}
2435 switch, but allow finer grained control. Multiple selections from the
2436 following may be specified as a comma separated string.
2441 Select disassembly for the given architecture.
2445 Select between intel syntax mode and AT&T syntax mode.
2449 Select between AMD64 ISA and Intel64 ISA.
2451 @item intel-mnemonic
2453 Select between intel mnemonic mode and AT&T mnemonic mode.
2454 Note: @code{intel-mnemonic} implies @code{intel} and
2455 @code{att-mnemonic} implies @code{att}.
2462 Specify the default address size and operand size. These five options
2463 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2464 appear later in the option string.
2467 When in AT&T mode, instructs the disassembler to print a mnemonic
2468 suffix even when the suffix could be inferred by the operands.
2471 For PowerPC, the @option{-M} argument @option{raw} selects
2472 disasssembly of hardware insns rather than aliases. For example, you
2473 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2474 rather than @code{li}. All of the @option{-m} arguments for
2475 @command{gas} that select a CPU are supported. These are:
2476 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2477 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2478 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2479 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2480 @option{booke32}, @option{cell}, @option{com}, @option{e200z4},
2481 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2482 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2483 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2484 @option{power8}, @option{power9}, @option{ppc}, @option{ppc32},
2485 @option{ppc64}, @option{ppc64bridge}, @option{ppcps}, @option{pwr},
2486 @option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2487 @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9},
2488 @option{pwrx}, @option{titan}, and @option{vle}.
2489 @option{32} and @option{64} modify the default or a prior CPU
2490 selection, disabling and enabling 64-bit insns respectively. In
2491 addition, @option{altivec}, @option{any}, @option{htm}, @option{vsx},
2492 and @option{spe} add capabilities to a previous @emph{or later} CPU
2493 selection. @option{any} will disassemble any opcode known to
2494 binutils, but in cases where an opcode has two different meanings or
2495 different arguments, you may not see the disassembly you expect.
2496 If you disassemble without giving a CPU selection, a default will be
2497 chosen from information gleaned by BFD from the object files headers,
2498 but the result again may not be as you expect.
2500 For MIPS, this option controls the printing of instruction mnemonic
2501 names and register names in disassembled instructions. Multiple
2502 selections from the following may be specified as a comma separated
2503 string, and invalid options are ignored:
2507 Print the 'raw' instruction mnemonic instead of some pseudo
2508 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2509 'sll' instead of 'nop', etc.
2512 Disassemble MSA instructions.
2515 Disassemble the virtualization ASE instructions.
2518 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2520 @item gpr-names=@var{ABI}
2521 Print GPR (general-purpose register) names as appropriate
2522 for the specified ABI. By default, GPR names are selected according to
2523 the ABI of the binary being disassembled.
2525 @item fpr-names=@var{ABI}
2526 Print FPR (floating-point register) names as
2527 appropriate for the specified ABI. By default, FPR numbers are printed
2530 @item cp0-names=@var{ARCH}
2531 Print CP0 (system control coprocessor; coprocessor 0) register names
2532 as appropriate for the CPU or architecture specified by
2533 @var{ARCH}. By default, CP0 register names are selected according to
2534 the architecture and CPU of the binary being disassembled.
2536 @item hwr-names=@var{ARCH}
2537 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2538 as appropriate for the CPU or architecture specified by
2539 @var{ARCH}. By default, HWR names are selected according to
2540 the architecture and CPU of the binary being disassembled.
2542 @item reg-names=@var{ABI}
2543 Print GPR and FPR names as appropriate for the selected ABI.
2545 @item reg-names=@var{ARCH}
2546 Print CPU-specific register names (CP0 register and HWR names)
2547 as appropriate for the selected CPU or architecture.
2550 For any of the options listed above, @var{ABI} or
2551 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2552 rather than names, for the selected types of registers.
2553 You can list the available values of @var{ABI} and @var{ARCH} using
2554 the @option{--help} option.
2556 For VAX, you can specify function entry addresses with @option{-M
2557 entry:0xf00ba}. You can use this multiple times to properly
2558 disassemble VAX binary files that don't contain symbol tables (like
2559 ROM dumps). In these cases, the function entry mask would otherwise
2560 be decoded as VAX instructions, which would probably lead the rest
2561 of the function being wrongly disassembled.
2564 @itemx --private-headers
2565 Print information that is specific to the object file format. The exact
2566 information printed depends upon the object file format. For some
2567 object file formats, no additional information is printed.
2569 @item -P @var{options}
2570 @itemx --private=@var{options}
2571 Print information that is specific to the object file format. The
2572 argument @var{options} is a comma separated list that depends on the
2573 format (the lists of options is displayed with the help).
2575 For XCOFF, the available options are:
2591 Not all object formats support this option. In particular the ELF
2592 format does not use it.
2596 @cindex relocation entries, in object file
2597 Print the relocation entries of the file. If used with @option{-d} or
2598 @option{-D}, the relocations are printed interspersed with the
2602 @itemx --dynamic-reloc
2603 @cindex dynamic relocation entries, in object file
2604 Print the dynamic relocation entries of the file. This is only
2605 meaningful for dynamic objects, such as certain types of shared
2606 libraries. As for @option{-r}, if used with @option{-d} or
2607 @option{-D}, the relocations are printed interspersed with the
2611 @itemx --full-contents
2612 @cindex sections, full contents
2613 @cindex object file sections
2614 Display the full contents of any sections requested. By default all
2615 non-empty sections are displayed.
2619 @cindex source disassembly
2620 @cindex disassembly, with source
2621 Display source code intermixed with disassembly, if possible. Implies
2624 @item --source-comment[=@var{txt}]
2625 @cindex source disassembly
2626 @cindex disassembly, with source
2627 Like the @option{-S} option, but all source code lines are displayed
2628 with a prefix of @var{txt}. Typically @var{txt} will be a comment
2629 string which can be used to distinguish the assembler code from the
2630 source code. If @var{txt} is not provided then a default string of
2631 @var{``# ``} (hash followed by a space), will be used.
2633 @item --prefix=@var{prefix}
2634 @cindex Add prefix to absolute paths
2635 Specify @var{prefix} to add to the absolute paths when used with
2638 @item --prefix-strip=@var{level}
2639 @cindex Strip absolute paths
2640 Indicate how many initial directory names to strip off the hardwired
2641 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2643 @item --show-raw-insn
2644 When disassembling instructions, print the instruction in hex as well as
2645 in symbolic form. This is the default except when
2646 @option{--prefix-addresses} is used.
2648 @item --no-show-raw-insn
2649 When disassembling instructions, do not print the instruction bytes.
2650 This is the default when @option{--prefix-addresses} is used.
2652 @item --insn-width=@var{width}
2653 @cindex Instruction width
2654 Display @var{width} bytes on a single line when disassembling
2657 @item -W[lLiaprmfFsoRtUuTgAckK]
2658 @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]
2659 @include debug.options.texi
2662 Enable additional checks for consistency of Dwarf information.
2664 @include ctf.options.texi
2670 @cindex debug symbols
2671 @cindex ELF object file format
2672 Display the full contents of any sections requested. Display the
2673 contents of the .stab and .stab.index and .stab.excl sections from an
2674 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2675 @code{.stab} debugging symbol-table entries are carried in an ELF
2676 section. In most other file formats, debugging symbol-table entries are
2677 interleaved with linkage symbols, and are visible in the @option{--syms}
2680 @item --start-address=@var{address}
2681 @cindex start-address
2682 Start displaying data at the specified address. This affects the output
2683 of the @option{-d}, @option{-r} and @option{-s} options.
2685 @item --stop-address=@var{address}
2686 @cindex stop-address
2687 Stop displaying data at the specified address. This affects the output
2688 of the @option{-d}, @option{-r} and @option{-s} options.
2692 @cindex symbol table entries, printing
2693 Print the symbol table entries of the file.
2694 This is similar to the information provided by the @samp{nm} program,
2695 although the display format is different. The format of the output
2696 depends upon the format of the file being dumped, but there are two main
2697 types. One looks like this:
2700 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2701 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2704 where the number inside the square brackets is the number of the entry
2705 in the symbol table, the @var{sec} number is the section number, the
2706 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2707 symbol's type, the @var{scl} number is the symbol's storage class and
2708 the @var{nx} value is the number of auxilary entries associated with
2709 the symbol. The last two fields are the symbol's value and its name.
2711 The other common output format, usually seen with ELF based files,
2715 00000000 l d .bss 00000000 .bss
2716 00000000 g .text 00000000 fred
2719 Here the first number is the symbol's value (sometimes refered to as
2720 its address). The next field is actually a set of characters and
2721 spaces indicating the flag bits that are set on the symbol. These
2722 characters are described below. Next is the section with which the
2723 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2724 not connected with any section), or @emph{*UND*} if the section is
2725 referenced in the file being dumped, but not defined there.
2727 After the section name comes another field, a number, which for common
2728 symbols is the alignment and for other symbol is the size. Finally
2729 the symbol's name is displayed.
2731 The flag characters are divided into 7 groups as follows:
2737 The symbol is a local (l), global (g), unique global (u), neither
2738 global nor local (a space) or both global and local (!). A
2739 symbol can be neither local or global for a variety of reasons, e.g.,
2740 because it is used for debugging, but it is probably an indication of
2741 a bug if it is ever both local and global. Unique global symbols are
2742 a GNU extension to the standard set of ELF symbol bindings. For such
2743 a symbol the dynamic linker will make sure that in the entire process
2744 there is just one symbol with this name and type in use.
2747 The symbol is weak (w) or strong (a space).
2750 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2753 The symbol is a warning (W) or a normal symbol (a space). A warning
2754 symbol's name is a message to be displayed if the symbol following the
2755 warning symbol is ever referenced.
2759 The symbol is an indirect reference to another symbol (I), a function
2760 to be evaluated during reloc processing (i) or a normal symbol (a
2765 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2766 normal symbol (a space).
2771 The symbol is the name of a function (F) or a file (f) or an object
2772 (O) or just a normal symbol (a space).
2776 @itemx --dynamic-syms
2777 @cindex dynamic symbol table entries, printing
2778 Print the dynamic symbol table entries of the file. This is only
2779 meaningful for dynamic objects, such as certain types of shared
2780 libraries. This is similar to the information provided by the @samp{nm}
2781 program when given the @option{-D} (@option{--dynamic}) option.
2783 The output format is similar to that produced by the @option{--syms}
2784 option, except that an extra field is inserted before the symbol's
2785 name, giving the version information associated with the symbol.
2786 If the version is the default version to be used when resolving
2787 unversioned references to the symbol then it's displayed as is,
2788 otherwise it's put into parentheses.
2790 @item --special-syms
2791 When displaying symbols include those which the target considers to be
2792 special in some way and which would not normally be of interest to the
2797 Print the version number of @command{objdump} and exit.
2800 @itemx --all-headers
2801 @cindex all header information, object file
2802 @cindex header information, all
2803 Display all available header information, including the symbol table and
2804 relocation entries. Using @option{-x} is equivalent to specifying all of
2805 @option{-a -f -h -p -r -t}.
2809 @cindex wide output, printing
2810 Format some lines for output devices that have more than 80 columns.
2811 Also do not truncate symbol names when they are displayed.
2814 @itemx --disassemble-zeroes
2815 Normally the disassembly output will skip blocks of zeroes. This
2816 option directs the disassembler to disassemble those blocks, just like
2823 @c man begin SEEALSO objdump
2824 nm(1), readelf(1), and the Info entries for @file{binutils}.
2832 @cindex archive contents
2833 @cindex symbol index
2835 @c man title ranlib generate an index to an archive
2838 @c man begin SYNOPSIS ranlib
2839 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2843 @c man begin DESCRIPTION ranlib
2845 @command{ranlib} generates an index to the contents of an archive and
2846 stores it in the archive. The index lists each symbol defined by a
2847 member of an archive that is a relocatable object file.
2849 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2851 An archive with such an index speeds up linking to the library and
2852 allows routines in the library to call each other without regard to
2853 their placement in the archive.
2855 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2856 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2861 @c man begin OPTIONS ranlib
2867 Show usage information for @command{ranlib}.
2872 Show the version number of @command{ranlib}.
2875 @cindex deterministic archives
2876 @kindex --enable-deterministic-archives
2877 Operate in @emph{deterministic} mode. The symbol map archive member's
2878 header will show zero for the UID, GID, and timestamp. When this
2879 option is used, multiple runs will produce identical output files.
2881 If @file{binutils} was configured with
2882 @option{--enable-deterministic-archives}, then this mode is on by
2883 default. It can be disabled with the @samp{-U} option, described
2887 Update the timestamp of the symbol map of an archive.
2890 @cindex deterministic archives
2891 @kindex --enable-deterministic-archives
2892 Do @emph{not} operate in @emph{deterministic} mode. This is the
2893 inverse of the @samp{-D} option, above: the archive index will get
2894 actual UID, GID, timestamp, and file mode values.
2896 If @file{binutils} was configured @emph{without}
2897 @option{--enable-deterministic-archives}, then this mode is on by
2905 @c man begin SEEALSO ranlib
2906 ar(1), nm(1), and the Info entries for @file{binutils}.
2914 @cindex section sizes
2916 @c man title size list section sizes and total size of binary files
2919 @c man begin SYNOPSIS size
2920 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
2922 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2924 [@option{-t}|@option{--totals}]
2925 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2926 [@var{objfile}@dots{}]
2930 @c man begin DESCRIPTION size
2932 The @sc{gnu} @command{size} utility lists the section sizes and the total
2933 size for each of the binary files @var{objfile} on its argument list.
2934 By default, one line of output is generated for each file or each
2935 module if the file is an archive.
2937 @var{objfile}@dots{} are the files to be examined. If none are
2938 specified, the file @code{a.out} will be used instead.
2942 @c man begin OPTIONS size
2944 The command-line options have the following meanings:
2950 @itemx --format=@var{compatibility}
2951 @cindex @command{size} display format
2952 Using one of these options, you can choose whether the output from @sc{gnu}
2953 @command{size} resembles output from System V @command{size} (using @option{-A},
2954 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2955 @option{--format=berkeley}). The default is the one-line format similar to
2956 Berkeley's. Alternatively, you can choose the GNU format output
2957 (using @option{-G}, or @option{--format=gnu}), this is similar to
2958 Berkeley's output format, but sizes are counted differently.
2959 @c Bonus for doc-source readers: you can also say --format=strange (or
2960 @c anything else that starts with 's') for sysv, and --format=boring (or
2961 @c anything else that starts with 'b') for Berkeley.
2963 Here is an example of the Berkeley (default) format of output from
2966 $ size --format=Berkeley ranlib size
2967 text data bss dec hex filename
2968 294880 81920 11592 388392 5ed28 ranlib
2969 294880 81920 11888 388688 5ee50 size
2972 The Berkeley style output counts read only data in the @code{text}
2973 column, not in the @code{data} column, the @code{dec} and @code{hex}
2974 columns both display the sum of the @code{text}, @code{data}, and
2975 @code{bss} columns in decimal and hexadecimal respectively.
2977 The GNU format counts read only data in the @code{data} column, not
2978 the @code{text} column, and only displays the sum of the @code{text},
2979 @code{data}, and @code{bss} columns once, in the @code{total} column.
2980 The @option{--radix} option can be used to change the number base for
2981 all columns. Here is the same data displayed with GNU conventions:
2984 $ size --format=GNU ranlib size
2985 text data bss total filename
2986 279880 96920 11592 388392 ranlib
2987 279880 96920 11888 388688 size
2991 This is the same data, but displayed closer to System V conventions:
2994 $ size --format=SysV ranlib size
3012 Show a summary of acceptable arguments and options.
3017 @itemx --radix=@var{number}
3018 @cindex @command{size} number format
3019 @cindex radix for section sizes
3020 Using one of these options, you can control whether the size of each
3021 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3022 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3023 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
3024 values (8, 10, 16) are supported. The total size is always given in two
3025 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3026 octal and hexadecimal if you're using @option{-o}.
3029 Print total size of common symbols in each file. When using Berkeley
3030 or GNU format these are included in the bss size.
3034 Show totals of all objects listed (Berkeley or GNU format mode only).
3036 @item --target=@var{bfdname}
3037 @cindex object code format
3038 Specify that the object-code format for @var{objfile} is
3039 @var{bfdname}. This option may not be necessary; @command{size} can
3040 automatically recognize many formats.
3041 @xref{Target Selection}, for more information.
3045 Display the version number of @command{size}.
3051 @c man begin SEEALSO size
3052 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3059 @cindex listings strings
3060 @cindex printing strings
3061 @cindex strings, printing
3063 @c man title strings print the sequences of printable characters in files
3066 @c man begin SYNOPSIS strings
3067 strings [@option{-afovV}] [@option{-}@var{min-len}]
3068 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3069 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3070 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3071 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3072 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3073 [@option{-w}] [@option{--include-all-whitespace}]
3074 [@option{-s}] [@option{--output-separator}@var{sep_string}]
3075 [@option{--help}] [@option{--version}] @var{file}@dots{}
3079 @c man begin DESCRIPTION strings
3081 For each @var{file} given, @sc{gnu} @command{strings} prints the
3082 printable character sequences that are at least 4 characters long (or
3083 the number given with the options below) and are followed by an
3084 unprintable character.
3086 Depending upon how the strings program was configured it will default
3087 to either displaying all the printable sequences that it can find in
3088 each file, or only those sequences that are in loadable, initialized
3089 data sections. If the file type in unrecognizable, or if strings is
3090 reading from stdin then it will always display all of the printable
3091 sequences that it can find.
3093 For backwards compatibility any file that occurs after a command-line
3094 option of just @option{-} will also be scanned in full, regardless of
3095 the presence of any @option{-d} option.
3097 @command{strings} is mainly useful for determining the contents of
3102 @c man begin OPTIONS strings
3108 Scan the whole file, regardless of what sections it contains or
3109 whether those sections are loaded or initialized. Normally this is
3110 the default behaviour, but strings can be configured so that the
3111 @option{-d} is the default instead.
3113 The @option{-} option is position dependent and forces strings to
3114 perform full scans of any file that is mentioned after the @option{-}
3115 on the command line, even if the @option{-d} option has been
3120 Only print strings from initialized, loaded data sections in the
3121 file. This may reduce the amount of garbage in the output, but it
3122 also exposes the strings program to any security flaws that may be
3123 present in the BFD library used to scan and load sections. Strings
3124 can be configured so that this option is the default behaviour. In
3125 such cases the @option{-a} option can be used to avoid using the BFD
3126 library and instead just print all of the strings found in the file.
3129 @itemx --print-file-name
3130 Print the name of the file before each string.
3133 Print a summary of the program usage on the standard output and exit.
3135 @item -@var{min-len}
3136 @itemx -n @var{min-len}
3137 @itemx --bytes=@var{min-len}
3138 Print sequences of characters that are at least @var{min-len} characters
3139 long, instead of the default 4.
3142 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3143 act like @samp{-t d} instead. Since we can not be compatible with both
3144 ways, we simply chose one.
3146 @item -t @var{radix}
3147 @itemx --radix=@var{radix}
3148 Print the offset within the file before each string. The single
3149 character argument specifies the radix of the offset---@samp{o} for
3150 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3152 @item -e @var{encoding}
3153 @itemx --encoding=@var{encoding}
3154 Select the character encoding of the strings that are to be found.
3155 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3156 characters (ASCII, ISO 8859, etc., default), @samp{S} =
3157 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3158 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3159 littleendian. Useful for finding wide character strings. (@samp{l}
3160 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3162 @item -T @var{bfdname}
3163 @itemx --target=@var{bfdname}
3164 @cindex object code format
3165 Specify an object code format other than your system's default format.
3166 @xref{Target Selection}, for more information.
3171 Print the program version number on the standard output and exit.
3174 @itemx --include-all-whitespace
3175 By default tab and space characters are included in the strings that
3176 are displayed, but other whitespace characters, such a newlines and
3177 carriage returns, are not. The @option{-w} option changes this so
3178 that all whitespace characters are considered to be part of a string.
3181 @itemx --output-separator
3182 By default, output strings are delimited by a new-line. This option
3183 allows you to supply any string to be used as the output record
3184 separator. Useful with --include-all-whitespace where strings
3185 may contain new-lines internally.
3191 @c man begin SEEALSO strings
3192 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3193 and the Info entries for @file{binutils}.
3201 @cindex removing symbols
3202 @cindex discarding symbols
3203 @cindex symbols, discarding
3205 @c man title strip discard symbols and other data from object files
3208 @c man begin SYNOPSIS strip
3209 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3210 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3211 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3212 [@option{-s}|@option{--strip-all}]
3213 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3214 [@option{--strip-dwo}]
3215 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3216 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3217 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3218 [@option{-w}|@option{--wildcard}]
3219 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3220 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3221 [@option{--remove-relocations=}@var{sectionpattern}]
3222 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3223 [@option{-D}|@option{--enable-deterministic-archives}]
3224 [@option{-U}|@option{--disable-deterministic-archives}]
3225 [@option{--keep-file-symbols}]
3226 [@option{--only-keep-debug}]
3227 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3228 [@option{--help}] [@option{--info}]
3229 @var{objfile}@dots{}
3233 @c man begin DESCRIPTION strip
3235 @sc{gnu} @command{strip} discards all symbols from object files
3236 @var{objfile}. The list of object files may include archives.
3237 At least one object file must be given.
3239 @command{strip} modifies the files named in its argument,
3240 rather than writing modified copies under different names.
3244 @c man begin OPTIONS strip
3247 @item -F @var{bfdname}
3248 @itemx --target=@var{bfdname}
3249 Treat the original @var{objfile} as a file with the object
3250 code format @var{bfdname}, and rewrite it in the same format.
3251 @xref{Target Selection}, for more information.
3254 Show a summary of the options to @command{strip} and exit.
3257 Display a list showing all architectures and object formats available.
3259 @item -I @var{bfdname}
3260 @itemx --input-target=@var{bfdname}
3261 Treat the original @var{objfile} as a file with the object
3262 code format @var{bfdname}.
3263 @xref{Target Selection}, for more information.
3265 @item -O @var{bfdname}
3266 @itemx --output-target=@var{bfdname}
3267 Replace @var{objfile} with a file in the output format @var{bfdname}.
3268 @xref{Target Selection}, for more information.
3270 @item -R @var{sectionname}
3271 @itemx --remove-section=@var{sectionname}
3272 Remove any section named @var{sectionname} from the output file, in
3273 addition to whatever sections would otherwise be removed. This
3274 option may be given more than once. Note that using this option
3275 inappropriately may make the output file unusable. The wildcard
3276 character @samp{*} may be given at the end of @var{sectionname}. If
3277 so, then any section starting with @var{sectionname} will be removed.
3279 If the first character of @var{sectionpattern} is the exclamation
3280 point (!) then matching sections will not be removed even if an
3281 earlier use of @option{--remove-section} on the same command line
3282 would otherwise remove it. For example:
3285 --remove-section=.text.* --remove-section=!.text.foo
3288 will remove all sections matching the pattern '.text.*', but will not
3289 remove the section '.text.foo'.
3291 @item --remove-relocations=@var{sectionpattern}
3292 Remove relocations from the output file for any section matching
3293 @var{sectionpattern}. This option may be given more than once. Note
3294 that using this option inappropriately may make the output file
3295 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3299 --remove-relocations=.text.*
3302 will remove the relocations for all sections matching the patter
3305 If the first character of @var{sectionpattern} is the exclamation
3306 point (!) then matching sections will not have their relocation
3307 removed even if an earlier use of @option{--remove-relocations} on the
3308 same command line would otherwise cause the relocations to be removed.
3312 --remove-relocations=.text.* --remove-relocations=!.text.foo
3315 will remove all relocations for sections matching the pattern
3316 '.text.*', but will not remove relocations for the section
3326 @itemx --strip-debug
3327 Remove debugging symbols only.
3330 Remove the contents of all DWARF .dwo sections, leaving the
3331 remaining debugging sections and all symbols intact.
3332 See the description of this option in the @command{objcopy} section
3333 for more information.
3335 @item --strip-unneeded
3336 Remove all symbols that are not needed for relocation processing.
3338 @item -K @var{symbolname}
3339 @itemx --keep-symbol=@var{symbolname}
3340 When stripping symbols, keep symbol @var{symbolname} even if it would
3341 normally be stripped. This option may be given more than once.
3344 @itemx --merge-notes
3345 @itemx --no-merge-notes
3346 For ELF files, attempt (or do not attempt) to reduce the size of any
3347 SHT_NOTE type sections by removing duplicate notes. The default is to
3348 attempt this reduction unless stripping debug or DWO information.
3350 @item -N @var{symbolname}
3351 @itemx --strip-symbol=@var{symbolname}
3352 Remove symbol @var{symbolname} from the source file. This option may be
3353 given more than once, and may be combined with strip options other than
3357 Put the stripped output in @var{file}, rather than replacing the
3358 existing file. When this argument is used, only one @var{objfile}
3359 argument may be specified.
3362 @itemx --preserve-dates
3363 Preserve the access and modification dates of the file.
3366 @itemx --enable-deterministic-archives
3367 @cindex deterministic archives
3368 @kindex --enable-deterministic-archives
3369 Operate in @emph{deterministic} mode. When copying archive members
3370 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3371 and use consistent file modes for all files.
3373 If @file{binutils} was configured with
3374 @option{--enable-deterministic-archives}, then this mode is on by default.
3375 It can be disabled with the @samp{-U} option, below.
3378 @itemx --disable-deterministic-archives
3379 @cindex deterministic archives
3380 @kindex --enable-deterministic-archives
3381 Do @emph{not} operate in @emph{deterministic} mode. This is the
3382 inverse of the @option{-D} option, above: when copying archive members
3383 and writing the archive index, use their actual UID, GID, timestamp,
3384 and file mode values.
3386 This is the default unless @file{binutils} was configured with
3387 @option{--enable-deterministic-archives}.
3391 Permit regular expressions in @var{symbolname}s used in other command
3392 line options. The question mark (?), asterisk (*), backslash (\) and
3393 square brackets ([]) operators can be used anywhere in the symbol
3394 name. If the first character of the symbol name is the exclamation
3395 point (!) then the sense of the switch is reversed for that symbol.
3402 would cause strip to only keep symbols that start with the letters
3403 ``fo'', but to discard the symbol ``foo''.
3406 @itemx --discard-all
3407 Remove non-global symbols.
3410 @itemx --discard-locals
3411 Remove compiler-generated local symbols.
3412 (These usually start with @samp{L} or @samp{.}.)
3414 @item --keep-file-symbols
3415 When stripping a file, perhaps with @option{--strip-debug} or
3416 @option{--strip-unneeded}, retain any symbols specifying source file names,
3417 which would otherwise get stripped.
3419 @item --only-keep-debug
3420 Strip a file, emptying the contents of any sections that would not be
3421 stripped by @option{--strip-debug} and leaving the debugging sections
3422 intact. In ELF files, this preserves all the note sections in the
3425 Note - the section headers of the stripped sections are preserved,
3426 including their sizes, but the contents of the section are discarded.
3427 The section headers are preserved so that other tools can match up the
3428 debuginfo file with the real executable, even if that executable has
3429 been relocated to a different address space.
3431 The intention is that this option will be used in conjunction with
3432 @option{--add-gnu-debuglink} to create a two part executable. One a
3433 stripped binary which will occupy less space in RAM and in a
3434 distribution and the second a debugging information file which is only
3435 needed if debugging abilities are required. The suggested procedure
3436 to create these files is as follows:
3439 @item Link the executable as normal. Assuming that it is called
3441 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3442 create a file containing the debugging info.
3443 @item Run @code{objcopy --strip-debug foo} to create a
3444 stripped executable.
3445 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3446 to add a link to the debugging info into the stripped executable.
3449 Note---the choice of @code{.dbg} as an extension for the debug info
3450 file is arbitrary. Also the @code{--only-keep-debug} step is
3451 optional. You could instead do this:
3454 @item Link the executable as normal.
3455 @item Copy @code{foo} to @code{foo.full}
3456 @item Run @code{strip --strip-debug foo}
3457 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3460 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3461 full executable. It does not have to be a file created by the
3462 @option{--only-keep-debug} switch.
3464 Note---this switch is only intended for use on fully linked files. It
3465 does not make sense to use it on object files where the debugging
3466 information may be incomplete. Besides the gnu_debuglink feature
3467 currently only supports the presence of one filename containing
3468 debugging information, not multiple filenames on a one-per-object-file
3473 Show the version number for @command{strip}.
3477 Verbose output: list all object files modified. In the case of
3478 archives, @samp{strip -v} lists all members of the archive.
3484 @c man begin SEEALSO strip
3485 the Info entries for @file{binutils}.
3489 @node c++filt, addr2line, strip, Top
3493 @cindex demangling C++ symbols
3495 @c man title cxxfilt demangle C++ and Java symbols
3498 @c man begin SYNOPSIS cxxfilt
3499 c++filt [@option{-_}|@option{--strip-underscore}]
3500 [@option{-n}|@option{--no-strip-underscore}]
3501 [@option{-p}|@option{--no-params}]
3502 [@option{-t}|@option{--types}]
3503 [@option{-i}|@option{--no-verbose}]
3504 [@option{-r}|@option{--no-recurse-limit}]
3505 [@option{-R}|@option{--recurse-limit}]
3506 [@option{-s} @var{format}|@option{--format=}@var{format}]
3507 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3511 @c man begin DESCRIPTION cxxfilt
3514 The C++ and Java languages provide function overloading, which means
3515 that you can write many functions with the same name, providing that
3516 each function takes parameters of different types. In order to be
3517 able to distinguish these similarly named functions C++ and Java
3518 encode them into a low-level assembler name which uniquely identifies
3519 each different version. This process is known as @dfn{mangling}. The
3521 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3522 MS-DOS this program is named @command{CXXFILT}.}
3523 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3524 names into user-level names so that they can be read.
3526 Every alphanumeric word (consisting of letters, digits, underscores,
3527 dollars, or periods) seen in the input is a potential mangled name.
3528 If the name decodes into a C++ name, the C++ name replaces the
3529 low-level name in the output, otherwise the original word is output.
3530 In this way you can pass an entire assembler source file, containing
3531 mangled names, through @command{c++filt} and see the same source file
3532 containing demangled names.
3534 You can also use @command{c++filt} to decipher individual symbols by
3535 passing them on the command line:
3538 c++filt @var{symbol}
3541 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3542 names from the standard input instead. All the results are printed on
3543 the standard output. The difference between reading names from the
3544 command line versus reading names from the standard input is that
3545 command-line arguments are expected to be just mangled names and no
3546 checking is performed to separate them from surrounding text. Thus
3553 will work and demangle the name to ``f()'' whereas:
3559 will not work. (Note the extra comma at the end of the mangled
3560 name which makes it invalid). This command however will work:
3563 echo _Z1fv, | c++filt -n
3566 and will display ``f(),'', i.e., the demangled name followed by a
3567 trailing comma. This behaviour is because when the names are read
3568 from the standard input it is expected that they might be part of an
3569 assembler source file where there might be extra, extraneous
3570 characters trailing after a mangled name. For example:
3573 .type _Z1fv, @@function
3578 @c man begin OPTIONS cxxfilt
3582 @itemx --strip-underscore
3583 On some systems, both the C and C++ compilers put an underscore in front
3584 of every name. For example, the C name @code{foo} gets the low-level
3585 name @code{_foo}. This option removes the initial underscore. Whether
3586 @command{c++filt} removes the underscore by default is target dependent.
3589 @itemx --no-strip-underscore
3590 Do not remove the initial underscore.
3594 When demangling the name of a function, do not display the types of
3595 the function's parameters.
3599 Attempt to demangle types as well as function names. This is disabled
3600 by default since mangled types are normally only used internally in
3601 the compiler, and they can be confused with non-mangled names. For example,
3602 a function called ``a'' treated as a mangled type name would be
3603 demangled to ``signed char''.
3607 Do not include implementation details (if any) in the demangled
3612 @itemx --recurse-limit
3613 @itemx --no-recurse-limit
3614 @itemx --recursion-limit
3615 @itemx --no-recursion-limit
3616 Enables or disables a limit on the amount of recursion performed
3617 whilst demangling strings. Since the name mangling formats allow for
3618 an inifinite level of recursion it is possible to create strings whose
3619 decoding will exhaust the amount of stack space available on the host
3620 machine, triggering a memory fault. The limit tries to prevent this
3621 from happening by restricting recursion to 2048 levels of nesting.
3623 The default is for this limit to be enabled, but disabling it may be
3624 necessary in order to demangle truly complicated names. Note however
3625 that if the recursion limit is disabled then stack exhaustion is
3626 possible and any bug reports about such an event will be rejected.
3628 The @option{-r} option is a synonym for the
3629 @option{--no-recurse-limit} option. The @option{-R} option is a
3630 synonym for the @option{--recurse-limit} option.
3632 @item -s @var{format}
3633 @itemx --format=@var{format}
3634 @command{c++filt} can decode various methods of mangling, used by
3635 different compilers. The argument to this option selects which
3640 Automatic selection based on executable (the default method)
3642 the one used by the @sc{gnu} C++ compiler (g++)
3644 the one used by the Lucid compiler (lcc)
3646 the one specified by the C++ Annotated Reference Manual
3648 the one used by the HP compiler (aCC)
3650 the one used by the EDG compiler
3652 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3654 the one used by the @sc{gnu} Java compiler (gcj)
3656 the one used by the @sc{gnu} Ada compiler (GNAT).
3660 Print a summary of the options to @command{c++filt} and exit.
3663 Print the version number of @command{c++filt} and exit.
3669 @c man begin SEEALSO cxxfilt
3670 the Info entries for @file{binutils}.
3675 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3676 user interface are subject to change in future releases. In particular,
3677 a command-line option may be required in the future to decode a name
3678 passed as an argument on the command line; in other words,
3681 c++filt @var{symbol}
3685 may in a future release become
3688 c++filt @var{option} @var{symbol}
3696 @cindex address to file name and line number
3698 @c man title addr2line convert addresses into file names and line numbers
3701 @c man begin SYNOPSIS addr2line
3702 addr2line [@option{-a}|@option{--addresses}]
3703 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3704 [@option{-C}|@option{--demangle}[=@var{style}]]
3705 [@option{-r}|@option{--no-recurse-limit}]
3706 [@option{-R}|@option{--recurse-limit}]
3707 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3708 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3709 [@option{-i}|@option{--inlines}]
3710 [@option{-p}|@option{--pretty-print}]
3711 [@option{-j}|@option{--section=}@var{name}]
3712 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3717 @c man begin DESCRIPTION addr2line
3719 @command{addr2line} translates addresses into file names and line numbers.
3720 Given an address in an executable or an offset in a section of a relocatable
3721 object, it uses the debugging information to figure out which file name and
3722 line number are associated with it.
3724 The executable or relocatable object to use is specified with the @option{-e}
3725 option. The default is the file @file{a.out}. The section in the relocatable
3726 object to use is specified with the @option{-j} option.
3728 @command{addr2line} has two modes of operation.
3730 In the first, hexadecimal addresses are specified on the command line,
3731 and @command{addr2line} displays the file name and line number for each
3734 In the second, @command{addr2line} reads hexadecimal addresses from
3735 standard input, and prints the file name and line number for each
3736 address on standard output. In this mode, @command{addr2line} may be used
3737 in a pipe to convert dynamically chosen addresses.
3739 The format of the output is @samp{FILENAME:LINENO}. By default
3740 each input address generates one line of output.
3742 Two options can generate additional lines before each
3743 @samp{FILENAME:LINENO} line (in that order).
3745 If the @option{-a} option is used then a line with the input address
3748 If the @option{-f} option is used, then a line with the
3749 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3750 containing the address.
3752 One option can generate additional lines after the
3753 @samp{FILENAME:LINENO} line.
3755 If the @option{-i} option is used and the code at the given address is
3756 present there because of inlining by the compiler then additional
3757 lines are displayed afterwards. One or two extra lines (if the
3758 @option{-f} option is used) are displayed for each inlined function.
3760 Alternatively if the @option{-p} option is used then each input
3761 address generates a single, long, output line containing the address,
3762 the function name, the file name and the line number. If the
3763 @option{-i} option has also been used then any inlined functions will
3764 be displayed in the same manner, but on separate lines, and prefixed
3765 by the text @samp{(inlined by)}.
3767 If the file name or function name can not be determined,
3768 @command{addr2line} will print two question marks in their place. If the
3769 line number can not be determined, @command{addr2line} will print 0.
3773 @c man begin OPTIONS addr2line
3775 The long and short forms of options, shown here as alternatives, are
3781 Display the address before the function name, file and line number
3782 information. The address is printed with a @samp{0x} prefix to easily
3785 @item -b @var{bfdname}
3786 @itemx --target=@var{bfdname}
3787 @cindex object code format
3788 Specify that the object-code format for the object files is
3792 @itemx --demangle[=@var{style}]
3793 @cindex demangling in objdump
3794 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3795 Besides removing any initial underscore prepended by the system, this
3796 makes C++ function names readable. Different compilers have different
3797 mangling styles. The optional demangling style argument can be used to
3798 choose an appropriate demangling style for your compiler. @xref{c++filt},
3799 for more information on demangling.
3801 @item -e @var{filename}
3802 @itemx --exe=@var{filename}
3803 Specify the name of the executable for which addresses should be
3804 translated. The default file is @file{a.out}.
3808 Display function names as well as file and line number information.
3812 Display only the base of each file name.
3816 If the address belongs to a function that was inlined, the source
3817 information for all enclosing scopes back to the first non-inlined
3818 function will also be printed. For example, if @code{main} inlines
3819 @code{callee1} which inlines @code{callee2}, and address is from
3820 @code{callee2}, the source information for @code{callee1} and @code{main}
3821 will also be printed.
3825 Read offsets relative to the specified section instead of absolute addresses.
3828 @itemx --pretty-print
3829 Make the output more human friendly: each location are printed on one line.
3830 If option @option{-i} is specified, lines for all enclosing scopes are
3831 prefixed with @samp{(inlined by)}.
3835 @itemx --recurse-limit
3836 @itemx --no-recurse-limit
3837 @itemx --recursion-limit
3838 @itemx --no-recursion-limit
3839 Enables or disables a limit on the amount of recursion performed
3840 whilst demangling strings. Since the name mangling formats allow for
3841 an inifinite level of recursion it is possible to create strings whose
3842 decoding will exhaust the amount of stack space available on the host
3843 machine, triggering a memory fault. The limit tries to prevent this
3844 from happening by restricting recursion to 2048 levels of nesting.
3846 The default is for this limit to be enabled, but disabling it may be
3847 necessary in order to demangle truly complicated names. Note however
3848 that if the recursion limit is disabled then stack exhaustion is
3849 possible and any bug reports about such an event will be rejected.
3851 The @option{-r} option is a synonym for the
3852 @option{--no-recurse-limit} option. The @option{-R} option is a
3853 synonym for the @option{--recurse-limit} option.
3855 Note this option is only effective if the @option{-C} or
3856 @option{--demangle} option has been enabled.
3863 @c man begin SEEALSO addr2line
3864 Info entries for @file{binutils}.
3871 @command{windmc} may be used to generator Windows message resources.
3874 @emph{Warning:} @command{windmc} is not always built as part of the binary
3875 utilities, since it is only useful for Windows targets.
3878 @c man title windmc generates Windows message resources
3881 @c man begin SYNOPSIS windmc
3882 windmc [options] input-file
3886 @c man begin DESCRIPTION windmc
3888 @command{windmc} reads message definitions from an input file (.mc) and
3889 translate them into a set of output files. The output files may be of
3894 A C header file containing the message definitions.
3897 A resource file compilable by the @command{windres} tool.
3900 One or more binary files containing the resource data for a specific
3904 A C include file that maps message id's to their symbolic name.
3907 The exact description of these different formats is available in
3908 documentation from Microsoft.
3910 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3911 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3912 Windows Message Compiler.
3916 @c man begin OPTIONS windmc
3921 Specifies that the input file specified is ASCII. This is the default
3926 Specifies that messages in the output @code{bin} files should be in ASCII
3931 Specifies that @code{bin} filenames should have to be prefixed by the
3932 basename of the source file.
3936 Sets the customer bit in all message id's.
3938 @item -C @var{codepage}
3939 @itemx --codepage_in @var{codepage}
3940 Sets the default codepage to be used to convert input file to UTF16. The
3941 default is ocdepage 1252.
3944 @itemx --decimal_values
3945 Outputs the constants in the header file in decimal. Default is using
3949 @itemx --extension @var{ext}
3950 The extension for the header file. The default is .h extension.
3952 @item -F @var{target}
3953 @itemx --target @var{target}
3954 Specify the BFD format to use for a bin file as output. This
3955 is a BFD target name; you can use the @option{--help} option to see a list
3956 of supported targets. Normally @command{windmc} will use the default
3957 format, which is the first one listed by the @option{--help} option.
3959 @ref{Target Selection}.
3963 @itemx --headerdir @var{path}
3964 The target directory of the generated header file. The default is the
3969 Displays a list of command-line options and then exits.
3971 @item -m @var{characters}
3972 @itemx --maxlength @var{characters}
3973 Instructs @command{windmc} to generate a warning if the length
3974 of any message exceeds the number specified.
3977 @itemx --nullterminate
3978 Terminate message text in @code{bin} files by zero. By default they are
3979 terminated by CR/LF.
3982 @itemx --hresult_use
3983 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3984 file, using HRESULT definitions. Status codes are used if the flag is not
3987 @item -O @var{codepage}
3988 @itemx --codepage_out @var{codepage}
3989 Sets the default codepage to be used to output text files. The default
3993 @itemx --rcdir @var{path}
3994 The target directory for the generated @code{rc} script and the generated
3995 @code{bin} files that the resource compiler script includes. The default
3996 is the current directory.
4000 Specifies that the input file is UTF16.
4003 @itemx --unicode_out
4004 Specifies that messages in the output @code{bin} file should be in UTF16
4005 format. This is the default behaviour.
4009 Enable verbose mode.
4013 Prints the version number for @command{windmc}.
4016 @itemx --xdgb @var{path}
4017 The path of the @code{dbg} C include file that maps message id's to the
4018 symbolic name. No such file is generated without specifying the switch.
4024 @c man begin SEEALSO windmc
4025 the Info entries for @file{binutils}.
4032 @command{windres} may be used to manipulate Windows resources.
4035 @emph{Warning:} @command{windres} is not always built as part of the binary
4036 utilities, since it is only useful for Windows targets.
4039 @c man title windres manipulate Windows resources
4042 @c man begin SYNOPSIS windres
4043 windres [options] [input-file] [output-file]
4047 @c man begin DESCRIPTION windres
4049 @command{windres} reads resources from an input file and copies them into
4050 an output file. Either file may be in one of three formats:
4054 A text format read by the Resource Compiler.
4057 A binary format generated by the Resource Compiler.
4060 A COFF object or executable.
4063 The exact description of these different formats is available in
4064 documentation from Microsoft.
4066 When @command{windres} converts from the @code{rc} format to the @code{res}
4067 format, it is acting like the Windows Resource Compiler. When
4068 @command{windres} converts from the @code{res} format to the @code{coff}
4069 format, it is acting like the Windows @code{CVTRES} program.
4071 When @command{windres} generates an @code{rc} file, the output is similar
4072 but not identical to the format expected for the input. When an input
4073 @code{rc} file refers to an external filename, an output @code{rc} file
4074 will instead include the file contents.
4076 If the input or output format is not specified, @command{windres} will
4077 guess based on the file name, or, for the input file, the file contents.
4078 A file with an extension of @file{.rc} will be treated as an @code{rc}
4079 file, a file with an extension of @file{.res} will be treated as a
4080 @code{res} file, and a file with an extension of @file{.o} or
4081 @file{.exe} will be treated as a @code{coff} file.
4083 If no output file is specified, @command{windres} will print the resources
4084 in @code{rc} format to standard output.
4086 The normal use is for you to write an @code{rc} file, use @command{windres}
4087 to convert it to a COFF object file, and then link the COFF file into
4088 your application. This will make the resources described in the
4089 @code{rc} file available to Windows.
4093 @c man begin OPTIONS windres
4096 @item -i @var{filename}
4097 @itemx --input @var{filename}
4098 The name of the input file. If this option is not used, then
4099 @command{windres} will use the first non-option argument as the input file
4100 name. If there are no non-option arguments, then @command{windres} will
4101 read from standard input. @command{windres} can not read a COFF file from
4104 @item -o @var{filename}
4105 @itemx --output @var{filename}
4106 The name of the output file. If this option is not used, then
4107 @command{windres} will use the first non-option argument, after any used
4108 for the input file name, as the output file name. If there is no
4109 non-option argument, then @command{windres} will write to standard output.
4110 @command{windres} can not write a COFF file to standard output. Note,
4111 for compatibility with @command{rc} the option @option{-fo} is also
4112 accepted, but its use is not recommended.
4114 @item -J @var{format}
4115 @itemx --input-format @var{format}
4116 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4117 @samp{coff}. If no input format is specified, @command{windres} will
4118 guess, as described above.
4120 @item -O @var{format}
4121 @itemx --output-format @var{format}
4122 The output format to generate. @var{format} may be @samp{res},
4123 @samp{rc}, or @samp{coff}. If no output format is specified,
4124 @command{windres} will guess, as described above.
4126 @item -F @var{target}
4127 @itemx --target @var{target}
4128 Specify the BFD format to use for a COFF file as input or output. This
4129 is a BFD target name; you can use the @option{--help} option to see a list
4130 of supported targets. Normally @command{windres} will use the default
4131 format, which is the first one listed by the @option{--help} option.
4133 @ref{Target Selection}.
4136 @item --preprocessor @var{program}
4137 When @command{windres} reads an @code{rc} file, it runs it through the C
4138 preprocessor first. This option may be used to specify the preprocessor
4139 to use, including any leading arguments. The default preprocessor
4140 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4142 @item --preprocessor-arg @var{option}
4143 When @command{windres} reads an @code{rc} file, it runs it through
4144 the C preprocessor first. This option may be used to specify additional
4145 text to be passed to preprocessor on its command line.
4146 This option can be used multiple times to add multiple options to the
4147 preprocessor command line.
4149 @item -I @var{directory}
4150 @itemx --include-dir @var{directory}
4151 Specify an include directory to use when reading an @code{rc} file.
4152 @command{windres} will pass this to the preprocessor as an @option{-I}
4153 option. @command{windres} will also search this directory when looking for
4154 files named in the @code{rc} file. If the argument passed to this command
4155 matches any of the supported @var{formats} (as described in the @option{-J}
4156 option), it will issue a deprecation warning, and behave just like the
4157 @option{-J} option. New programs should not use this behaviour. If a
4158 directory happens to match a @var{format}, simple prefix it with @samp{./}
4159 to disable the backward compatibility.
4161 @item -D @var{target}
4162 @itemx --define @var{sym}[=@var{val}]
4163 Specify a @option{-D} option to pass to the preprocessor when reading an
4166 @item -U @var{target}
4167 @itemx --undefine @var{sym}
4168 Specify a @option{-U} option to pass to the preprocessor when reading an
4172 Ignored for compatibility with rc.
4175 Enable verbose mode. This tells you what the preprocessor is if you
4179 @item --codepage @var{val}
4180 Specify the default codepage to use when reading an @code{rc} file.
4181 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4182 codepage code. The valid range is from zero up to 0xffff, but the
4183 validity of the codepage is host and configuration dependent.
4186 @item --language @var{val}
4187 Specify the default language to use when reading an @code{rc} file.
4188 @var{val} should be a hexadecimal language code. The low eight bits are
4189 the language, and the high eight bits are the sublanguage.
4191 @item --use-temp-file
4192 Use a temporary file to instead of using popen to read the output of
4193 the preprocessor. Use this option if the popen implementation is buggy
4194 on the host (eg., certain non-English language versions of Windows 95 and
4195 Windows 98 are known to have buggy popen where the output will instead
4198 @item --no-use-temp-file
4199 Use popen, not a temporary file, to read the output of the preprocessor.
4200 This is the default behaviour.
4204 Prints a usage summary.
4208 Prints the version number for @command{windres}.
4211 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4212 this will turn on parser debugging.
4218 @c man begin SEEALSO windres
4219 the Info entries for @file{binutils}.
4228 @command{dlltool} is used to create the files needed to create dynamic
4229 link libraries (DLLs) on systems which understand PE format image
4230 files such as Windows. A DLL contains an export table which contains
4231 information that the runtime loader needs to resolve references from a
4232 referencing program.
4234 The export table is generated by this program by reading in a
4235 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4236 will be in the DLL. A @file{.o} file can contain information in
4237 special @samp{.drectve} sections with export information.
4240 @emph{Note:} @command{dlltool} is not always built as part of the
4241 binary utilities, since it is only useful for those targets which
4245 @c man title dlltool create files needed to build and use DLLs
4248 @c man begin SYNOPSIS dlltool
4249 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4250 [@option{-b}|@option{--base-file} @var{base-file-name}]
4251 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4252 [@option{-z}|@option{--output-def} @var{def-file-name}]
4253 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4254 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4255 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4256 [@option{--exclude-symbols} @var{list}]
4257 [@option{--no-default-excludes}]
4258 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4259 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4260 [@option{-a}|@option{--add-indirect}]
4261 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4262 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4263 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4264 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4265 [@option{--use-nul-prefixed-import-tables}]
4266 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4267 [@option{-i}|@option{--interwork}]
4268 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4269 [@option{-v}|@option{--verbose}]
4270 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4271 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4272 [object-file @dots{}]
4276 @c man begin DESCRIPTION dlltool
4278 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4279 @option{-b} options as well as object files specified on the command
4280 line. It then processes these inputs and if the @option{-e} option has
4281 been specified it creates a exports file. If the @option{-l} option
4282 has been specified it creates a library file and if the @option{-z} option
4283 has been specified it creates a def file. Any or all of the @option{-e},
4284 @option{-l} and @option{-z} options can be present in one invocation of
4287 When creating a DLL, along with the source for the DLL, it is necessary
4288 to have three other files. @command{dlltool} can help with the creation of
4291 The first file is a @file{.def} file which specifies which functions are
4292 exported from the DLL, which functions the DLL imports, and so on. This
4293 is a text file and can be created by hand, or @command{dlltool} can be used
4294 to create it using the @option{-z} option. In this case @command{dlltool}
4295 will scan the object files specified on its command line looking for
4296 those functions which have been specially marked as being exported and
4297 put entries for them in the @file{.def} file it creates.
4299 In order to mark a function as being exported from a DLL, it needs to
4300 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4301 section of the object file. This can be done in C by using the
4305 asm (".section .drectve");
4306 asm (".ascii \"-export:my_func\"");
4308 int my_func (void) @{ @dots{} @}
4311 The second file needed for DLL creation is an exports file. This file
4312 is linked with the object files that make up the body of the DLL and it
4313 handles the interface between the DLL and the outside world. This is a
4314 binary file and it can be created by giving the @option{-e} option to
4315 @command{dlltool} when it is creating or reading in a @file{.def} file.
4317 The third file needed for DLL creation is the library file that programs
4318 will link with in order to access the functions in the DLL (an `import
4319 library'). This file can be created by giving the @option{-l} option to
4320 dlltool when it is creating or reading in a @file{.def} file.
4322 If the @option{-y} option is specified, dlltool generates a delay-import
4323 library that can be used instead of the normal import library to allow
4324 a program to link to the dll only as soon as an imported function is
4325 called for the first time. The resulting executable will need to be
4326 linked to the static delayimp library containing __delayLoadHelper2(),
4327 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4329 @command{dlltool} builds the library file by hand, but it builds the
4330 exports file by creating temporary files containing assembler statements
4331 and then assembling these. The @option{-S} command-line option can be
4332 used to specify the path to the assembler that dlltool will use,
4333 and the @option{-f} option can be used to pass specific flags to that
4334 assembler. The @option{-n} can be used to prevent dlltool from deleting
4335 these temporary assembler files when it is done, and if @option{-n} is
4336 specified twice then this will prevent dlltool from deleting the
4337 temporary object files it used to build the library.
4339 Here is an example of creating a DLL from a source file @samp{dll.c} and
4340 also creating a program (from an object file called @samp{program.o})
4345 dlltool -e exports.o -l dll.lib dll.o
4346 gcc dll.o exports.o -o dll.dll
4347 gcc program.o dll.lib -o program
4351 @command{dlltool} may also be used to query an existing import library
4352 to determine the name of the DLL to which it is associated. See the
4353 description of the @option{-I} or @option{--identify} option.
4357 @c man begin OPTIONS dlltool
4359 The command-line options have the following meanings:
4363 @item -d @var{filename}
4364 @itemx --input-def @var{filename}
4365 @cindex input .def file
4366 Specifies the name of a @file{.def} file to be read in and processed.
4368 @item -b @var{filename}
4369 @itemx --base-file @var{filename}
4371 Specifies the name of a base file to be read in and processed. The
4372 contents of this file will be added to the relocation section in the
4373 exports file generated by dlltool.
4375 @item -e @var{filename}
4376 @itemx --output-exp @var{filename}
4377 Specifies the name of the export file to be created by dlltool.
4379 @item -z @var{filename}
4380 @itemx --output-def @var{filename}
4381 Specifies the name of the @file{.def} file to be created by dlltool.
4383 @item -l @var{filename}
4384 @itemx --output-lib @var{filename}
4385 Specifies the name of the library file to be created by dlltool.
4387 @item -y @var{filename}
4388 @itemx --output-delaylib @var{filename}
4389 Specifies the name of the delay-import library file to be created by dlltool.
4391 @item --export-all-symbols
4392 Treat all global and weak defined symbols found in the input object
4393 files as symbols to be exported. There is a small list of symbols which
4394 are not exported by default; see the @option{--no-default-excludes}
4395 option. You may add to the list of symbols to not export by using the
4396 @option{--exclude-symbols} option.
4398 @item --no-export-all-symbols
4399 Only export symbols explicitly listed in an input @file{.def} file or in
4400 @samp{.drectve} sections in the input object files. This is the default
4401 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4402 attributes in the source code.
4404 @item --exclude-symbols @var{list}
4405 Do not export the symbols in @var{list}. This is a list of symbol names
4406 separated by comma or colon characters. The symbol names should not
4407 contain a leading underscore. This is only meaningful when
4408 @option{--export-all-symbols} is used.
4410 @item --no-default-excludes
4411 When @option{--export-all-symbols} is used, it will by default avoid
4412 exporting certain special symbols. The current list of symbols to avoid
4413 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4414 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4415 to go ahead and export these special symbols. This is only meaningful
4416 when @option{--export-all-symbols} is used.
4419 @itemx --as @var{path}
4420 Specifies the path, including the filename, of the assembler to be used
4421 to create the exports file.
4423 @item -f @var{options}
4424 @itemx --as-flags @var{options}
4425 Specifies any specific command-line options to be passed to the
4426 assembler when building the exports file. This option will work even if
4427 the @option{-S} option is not used. This option only takes one argument,
4428 and if it occurs more than once on the command line, then later
4429 occurrences will override earlier occurrences. So if it is necessary to
4430 pass multiple options to the assembler they should be enclosed in
4434 @itemx --dll-name @var{name}
4435 Specifies the name to be stored in the @file{.def} file as the name of
4436 the DLL when the @option{-e} option is used. If this option is not
4437 present, then the filename given to the @option{-e} option will be
4438 used as the name of the DLL.
4440 @item -m @var{machine}
4441 @itemx -machine @var{machine}
4442 Specifies the type of machine for which the library file should be
4443 built. @command{dlltool} has a built in default type, depending upon how
4444 it was created, but this option can be used to override that. This is
4445 normally only useful when creating DLLs for an ARM processor, when the
4446 contents of the DLL are actually encode using Thumb instructions.
4449 @itemx --add-indirect
4450 Specifies that when @command{dlltool} is creating the exports file it
4451 should add a section which allows the exported functions to be
4452 referenced without using the import library. Whatever the hell that
4456 @itemx --add-underscore
4457 Specifies that when @command{dlltool} is creating the exports file it
4458 should prepend an underscore to the names of @emph{all} exported symbols.
4460 @item --no-leading-underscore
4461 @item --leading-underscore
4462 Specifies whether standard symbol should be forced to be prefixed, or
4465 @item --add-stdcall-underscore
4466 Specifies that when @command{dlltool} is creating the exports file it
4467 should prepend an underscore to the names of exported @emph{stdcall}
4468 functions. Variable names and non-stdcall function names are not modified.
4469 This option is useful when creating GNU-compatible import libs for third
4470 party DLLs that were built with MS-Windows tools.
4474 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4475 of stdcall functions that will be imported from the DLL. This is
4476 useful when creating an import library for a DLL which exports stdcall
4477 functions but without the usual @samp{@@<number>} symbol name suffix.
4479 This does not change the naming of symbols provided by the import library
4480 to programs linked against it, but only the entries in the import table
4481 (ie the .idata section).
4484 @itemx --add-stdcall-alias
4485 Specifies that when @command{dlltool} is creating the exports file it
4486 should add aliases for stdcall symbols without @samp{@@ <number>}
4487 in addition to the symbols with @samp{@@ <number>}.
4490 @itemx --ext-prefix-alias @var{prefix}
4491 Causes @command{dlltool} to create external aliases for all DLL
4492 imports with the specified prefix. The aliases are created for both
4493 external and import symbols with no leading underscore.
4497 Specifies that when @command{dlltool} is creating the exports and library
4498 files it should omit the @code{.idata4} section. This is for compatibility
4499 with certain operating systems.
4501 @item --use-nul-prefixed-import-tables
4502 Specifies that when @command{dlltool} is creating the exports and library
4503 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4504 element. This emulates old gnu import library generation of
4505 @code{dlltool}. By default this option is turned off.
4509 Specifies that when @command{dlltool} is creating the exports and library
4510 files it should omit the @code{.idata5} section. This is for compatibility
4511 with certain operating systems.
4513 @item -I @var{filename}
4514 @itemx --identify @var{filename}
4515 Specifies that @command{dlltool} should inspect the import library
4516 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4517 of the associated DLL(s). This can be performed in addition to any
4518 other operations indicated by the other options and arguments.
4519 @command{dlltool} fails if the import library does not exist or is not
4520 actually an import library. See also @option{--identify-strict}.
4522 @item --identify-strict
4523 Modifies the behavior of the @option{--identify} option, such
4524 that an error is reported if @var{filename} is associated with
4529 Specifies that @command{dlltool} should mark the objects in the library
4530 file and exports file that it produces as supporting interworking
4531 between ARM and Thumb code.
4535 Makes @command{dlltool} preserve the temporary assembler files it used to
4536 create the exports file. If this option is repeated then dlltool will
4537 also preserve the temporary object files it uses to create the library
4540 @item -t @var{prefix}
4541 @itemx --temp-prefix @var{prefix}
4542 Makes @command{dlltool} use @var{prefix} when constructing the names of
4543 temporary assembler and object files. By default, the temp file prefix
4544 is generated from the pid.
4548 Make dlltool describe what it is doing.
4552 Displays a list of command-line options and then exits.
4556 Displays dlltool's version number and then exits.
4563 * def file format:: The format of the dlltool @file{.def} file
4566 @node def file format
4567 @section The format of the @command{dlltool} @file{.def} file
4569 A @file{.def} file contains any number of the following commands:
4573 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4574 The result is going to be named @var{name}@code{.exe}.
4576 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4577 The result is going to be named @var{name}@code{.dll}.
4578 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4579 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4582 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4583 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4584 Declares @var{name1} as an exported symbol from the DLL, with optional
4585 ordinal number @var{integer}, or declares @var{name1} as an alias
4586 (forward) of the function @var{external-name} in the DLL.
4587 If @var{its_name} is specified, this name is used as string in export table.
4589 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4590 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4591 If you want to use LIBRARY as name then you need to quote it.
4593 @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{]} *}
4594 Declares that @var{external-name} or the exported function whose
4595 ordinal number is @var{integer} is to be imported from the file
4596 @var{module-name}. If @var{internal-name} is specified then this is
4597 the name that the imported function will be referred to in the body of
4599 If @var{its_name} is specified, this name is used as string in import table.
4600 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4601 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4602 If you want to use LIBRARY as name then you need to quote it.
4604 @item @code{DESCRIPTION} @var{string}
4605 Puts @var{string} into the output @file{.exp} file in the
4606 @code{.rdata} section.
4608 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4609 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4610 Generates @code{--stack} or @code{--heap}
4611 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4612 section. The linker will see this and act upon it.
4614 @item @code{CODE} @var{attr} @code{+}
4615 @item @code{DATA} @var{attr} @code{+}
4616 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4617 Generates @code{--attr} @var{section-name} @var{attr} in the output
4618 @code{.drectve} section, where @var{attr} is one of @code{READ},
4619 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4620 this and act upon it.
4625 @c man begin SEEALSO dlltool
4626 The Info pages for @file{binutils}.
4633 @cindex ELF file information
4636 @c man title readelf display information about ELF files
4639 @c man begin SYNOPSIS readelf
4640 readelf [@option{-a}|@option{--all}]
4641 [@option{-h}|@option{--file-header}]
4642 [@option{-l}|@option{--program-headers}|@option{--segments}]
4643 [@option{-S}|@option{--section-headers}|@option{--sections}]
4644 [@option{-g}|@option{--section-groups}]
4645 [@option{-t}|@option{--section-details}]
4646 [@option{-e}|@option{--headers}]
4647 [@option{-s}|@option{--syms}|@option{--symbols}]
4648 [@option{--dyn-syms}]
4649 [@option{-n}|@option{--notes}]
4650 [@option{-r}|@option{--relocs}]
4651 [@option{-u}|@option{--unwind}]
4652 [@option{-d}|@option{--dynamic}]
4653 [@option{-V}|@option{--version-info}]
4654 [@option{-A}|@option{--arch-specific}]
4655 [@option{-D}|@option{--use-dynamic}]
4656 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4657 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4658 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4659 [@option{-z}|@option{--decompress}]
4660 [@option{-c}|@option{--archive-index}]
4661 [@option{-w[lLiaprmfFsoRtUuTgAckK]}|
4662 @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]]
4663 [@option{--dwarf-depth=@var{n}}]
4664 [@option{--dwarf-start=@var{n}}]
4665 [@option{--ctf=}@var{section}]
4666 [@option{--ctf-parent=}@var{section}]
4667 [@option{--ctf-symbols=}@var{section}]
4668 [@option{--ctf-strings=}@var{section}]
4669 [@option{-I}|@option{--histogram}]
4670 [@option{-v}|@option{--version}]
4671 [@option{-W}|@option{--wide}]
4672 [@option{-H}|@option{--help}]
4673 @var{elffile}@dots{}
4677 @c man begin DESCRIPTION readelf
4679 @command{readelf} displays information about one or more ELF format object
4680 files. The options control what particular information to display.
4682 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4683 64-bit ELF files are supported, as are archives containing ELF files.
4685 This program performs a similar function to @command{objdump} but it
4686 goes into more detail and it exists independently of the @sc{bfd}
4687 library, so if there is a bug in @sc{bfd} then readelf will not be
4692 @c man begin OPTIONS readelf
4694 The long and short forms of options, shown here as alternatives, are
4695 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4701 Equivalent to specifying @option{--file-header},
4702 @option{--program-headers}, @option{--sections}, @option{--symbols},
4703 @option{--relocs}, @option{--dynamic}, @option{--notes},
4704 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
4705 @option{--section-groups} and @option{--histogram}.
4707 Note - this option does not enable @option{--use-dynamic} itself, so
4708 if that option is not present on the command line then dynamic symbols
4709 and dynamic relocs will not be displayed.
4712 @itemx --file-header
4713 @cindex ELF file header information
4714 Displays the information contained in the ELF header at the start of the
4718 @itemx --program-headers
4720 @cindex ELF program header information
4721 @cindex ELF segment information
4722 Displays the information contained in the file's segment headers, if it
4727 @itemx --section-headers
4728 @cindex ELF section information
4729 Displays the information contained in the file's section headers, if it
4733 @itemx --section-groups
4734 @cindex ELF section group information
4735 Displays the information contained in the file's section groups, if it
4739 @itemx --section-details
4740 @cindex ELF section information
4741 Displays the detailed section information. Implies @option{-S}.
4746 @cindex ELF symbol table information
4747 Displays the entries in symbol table section of the file, if it has one.
4748 If a symbol has version information associated with it then this is
4749 displayed as well. The version string is displayed as a suffix to the
4750 symbol name, preceeded by an @@ character. For example
4751 @samp{foo@@VER_1}. If the version is the default version to be used
4752 when resolving unversioned references to the symbol then it is
4753 displayed as a suffix preceeded by two @@ characters. For example
4754 @samp{foo@@@@VER_2}.
4757 @cindex ELF dynamic symbol table information
4758 Displays the entries in dynamic symbol table section of the file, if it
4759 has one. The output format is the same as the format used by the
4760 @option{--syms} option.
4764 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4769 Displays the contents of the NOTE segments and/or sections, if any.
4773 @cindex ELF reloc information
4774 Displays the contents of the file's relocation section, if it has one.
4778 @cindex unwind information
4779 Displays the contents of the file's unwind section, if it has one. Only
4780 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4781 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. If
4782 support is not yet implemented for your architecture you could try
4783 dumping the contents of the @var{.eh_frames} section using the
4784 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
4789 @cindex ELF dynamic section information
4790 Displays the contents of the file's dynamic section, if it has one.
4793 @itemx --version-info
4794 @cindex ELF version sections information
4795 Displays the contents of the version sections in the file, it they
4799 @itemx --arch-specific
4800 Displays architecture-specific information in the file, if there
4804 @itemx --use-dynamic
4805 When displaying symbols, this option makes @command{readelf} use the
4806 symbol hash tables in the file's dynamic section, rather than the
4807 symbol table sections.
4809 When displaying relocations, this option makes @command{readelf}
4810 display the dynamic relocations rather than the static relocations.
4812 @item -x <number or name>
4813 @itemx --hex-dump=<number or name>
4814 Displays the contents of the indicated section as a hexadecimal bytes.
4815 A number identifies a particular section by index in the section table;
4816 any other string identifies all sections with that name in the object file.
4818 @item -R <number or name>
4819 @itemx --relocated-dump=<number or name>
4820 Displays the contents of the indicated section as a hexadecimal
4821 bytes. A number identifies a particular section by index in the
4822 section table; any other string identifies all sections with that name
4823 in the object file. The contents of the section will be relocated
4824 before they are displayed.
4826 @item -p <number or name>
4827 @itemx --string-dump=<number or name>
4828 Displays the contents of the indicated section as printable strings.
4829 A number identifies a particular section by index in the section table;
4830 any other string identifies all sections with that name in the object file.
4834 Requests that the section(s) being dumped by @option{x}, @option{R} or
4835 @option{p} options are decompressed before being displayed. If the
4836 section(s) are not compressed then they are displayed as is.
4839 @itemx --archive-index
4840 @cindex Archive file symbol index information
4841 Displays the file symbol index information contained in the header part
4842 of binary archives. Performs the same function as the @option{t}
4843 command to @command{ar}, but without using the BFD library. @xref{ar}.
4845 @item -w[lLiaprmfFsoRtUuTgAckK]
4846 @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]
4847 @include debug.options.texi
4849 @include ctf.options.texi
4850 @item --ctf-symbols=@var{section}
4851 @item --ctf-strings=@var{section}
4852 Specify the name of another section from which the CTF file can inherit
4853 strings and symbols. By default, the @code{.symtab} and its linked
4854 string table are used.
4856 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
4857 other must be specified as well.
4861 Display a histogram of bucket list lengths when displaying the contents
4862 of the symbol tables.
4866 Display the version number of readelf.
4870 Don't break output lines to fit into 80 columns. By default
4871 @command{readelf} breaks section header and segment listing lines for
4872 64-bit ELF files, so that they fit into 80 columns. This option causes
4873 @command{readelf} to print each section header resp. each segment one a
4874 single line, which is far more readable on terminals wider than 80 columns.
4878 Display the command-line options understood by @command{readelf}.
4885 @c man begin SEEALSO readelf
4886 objdump(1), and the Info entries for @file{binutils}.
4893 @cindex Update ELF header
4896 @c man title elfedit update ELF header and program property of ELF files
4899 @c man begin SYNOPSIS elfedit
4900 elfedit [@option{--input-mach=}@var{machine}]
4901 [@option{--input-type=}@var{type}]
4902 [@option{--input-osabi=}@var{osabi}]
4903 @option{--output-mach=}@var{machine}
4904 @option{--output-type=}@var{type}
4905 @option{--output-osabi=}@var{osabi}
4906 @option{--enable-x86-feature=}@var{feature}
4907 @option{--disable-x86-feature=}@var{feature}
4908 [@option{-v}|@option{--version}]
4909 [@option{-h}|@option{--help}]
4910 @var{elffile}@dots{}
4914 @c man begin DESCRIPTION elfedit
4916 @command{elfedit} updates the ELF header and program property of ELF
4917 files which have the matching ELF machine and file types. The options
4918 control how and which fields in the ELF header and program property
4921 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4922 64-bit ELF files are supported, as are archives containing ELF files.
4925 @c man begin OPTIONS elfedit
4927 The long and short forms of options, shown here as alternatives, are
4928 equivalent. At least one of the @option{--output-mach},
4929 @option{--output-type}, @option{--output-osabi},
4930 @option{--enable-x86-feature} and @option{--disable-x86-feature}
4931 options must be given.
4935 @item --input-mach=@var{machine}
4936 Set the matching input ELF machine type to @var{machine}. If
4937 @option{--input-mach} isn't specified, it will match any ELF
4940 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4941 @var{K1OM} and @var{x86-64}.
4943 @item --output-mach=@var{machine}
4944 Change the ELF machine type in the ELF header to @var{machine}. The
4945 supported ELF machine types are the same as @option{--input-mach}.
4947 @item --input-type=@var{type}
4948 Set the matching input ELF file type to @var{type}. If
4949 @option{--input-type} isn't specified, it will match any ELF file types.
4951 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4953 @item --output-type=@var{type}
4954 Change the ELF file type in the ELF header to @var{type}. The
4955 supported ELF types are the same as @option{--input-type}.
4957 @item --input-osabi=@var{osabi}
4958 Set the matching input ELF file OSABI to @var{osabi}. If
4959 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4961 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4962 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4963 @var{Solaris}, @var{AIX}, @var{Irix},
4964 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4965 @var{NSK}, @var{AROS} and @var{FenixOS}.
4967 @item --output-osabi=@var{osabi}
4968 Change the ELF OSABI in the ELF header to @var{osabi}. The
4969 supported ELF OSABI are the same as @option{--input-osabi}.
4971 @item --enable-x86-feature=@var{feature}
4972 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
4973 ELF files with machine types of @var{i386} or @var{x86-64}. The
4974 supported features are, @var{ibt} and @var{shstk}.
4976 @item --disable-x86-feature=@var{feature}
4977 Clear the @var{feature} bit in program property in @var{exec} or
4978 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
4979 The supported features are the same as @option{--enable-x86-feature}.
4981 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
4982 are available only on hosts with @samp{mmap} support.
4986 Display the version number of @command{elfedit}.
4990 Display the command-line options understood by @command{elfedit}.
4997 @c man begin SEEALSO elfedit
4998 readelf(1), and the Info entries for @file{binutils}.
5002 @node Common Options
5003 @chapter Common Options
5005 The following command-line options are supported by all of the
5006 programs described in this manual.
5008 @c man begin OPTIONS
5010 @include at-file.texi
5014 Display the command-line options supported by the program.
5017 Display the version number of the program.
5019 @c man begin OPTIONS
5023 @node Selecting the Target System
5024 @chapter Selecting the Target System
5026 You can specify two aspects of the target system to the @sc{gnu}
5027 binary file utilities, each in several ways:
5037 In the following summaries, the lists of ways to specify values are in
5038 order of decreasing precedence. The ways listed first override those
5041 The commands to list valid values only list the values for which the
5042 programs you are running were configured. If they were configured with
5043 @option{--enable-targets=all}, the commands list most of the available
5044 values, but a few are left out; not all targets can be configured in at
5045 once because some of them can only be configured @dfn{native} (on hosts
5046 with the same type as the target system).
5049 * Target Selection::
5050 * Architecture Selection::
5053 @node Target Selection
5054 @section Target Selection
5056 A @dfn{target} is an object file format. A given target may be
5057 supported for multiple architectures (@pxref{Architecture Selection}).
5058 A target selection may also have variations for different operating
5059 systems or architectures.
5061 The command to list valid target values is @samp{objdump -i}
5062 (the first column of output contains the relevant information).
5064 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5065 @samp{a.out-sunos-big}.
5067 You can also specify a target using a configuration triplet. This is
5068 the same sort of name that is passed to @file{configure} to specify a
5069 target. When you use a configuration triplet as an argument, it must be
5070 fully canonicalized. You can see the canonical version of a triplet by
5071 running the shell script @file{config.sub} which is included with the
5074 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5075 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5077 @subheading @command{objdump} Target
5083 command-line option: @option{-b} or @option{--target}
5086 environment variable @code{GNUTARGET}
5089 deduced from the input file
5092 @subheading @command{objcopy} and @command{strip} Input Target
5098 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5101 environment variable @code{GNUTARGET}
5104 deduced from the input file
5107 @subheading @command{objcopy} and @command{strip} Output Target
5113 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5116 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5119 environment variable @code{GNUTARGET}
5122 deduced from the input file
5125 @subheading @command{nm}, @command{size}, and @command{strings} Target
5131 command-line option: @option{--target}
5134 environment variable @code{GNUTARGET}
5137 deduced from the input file
5140 @node Architecture Selection
5141 @section Architecture Selection
5143 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5144 to run. Its name may contain a colon, separating the name of the
5145 processor family from the name of the particular @sc{cpu}.
5147 The command to list valid architecture values is @samp{objdump -i} (the
5148 second column contains the relevant information).
5150 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5152 @subheading @command{objdump} Architecture
5158 command-line option: @option{-m} or @option{--architecture}
5161 deduced from the input file
5164 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5170 deduced from the input file
5173 @node Reporting Bugs
5174 @chapter Reporting Bugs
5176 @cindex reporting bugs
5178 Your bug reports play an essential role in making the binary utilities
5181 Reporting a bug may help you by bringing a solution to your problem, or
5182 it may not. But in any case the principal function of a bug report is
5183 to help the entire community by making the next version of the binary
5184 utilities work better. Bug reports are your contribution to their
5187 In order for a bug report to serve its purpose, you must include the
5188 information that enables us to fix the bug.
5191 * Bug Criteria:: Have you found a bug?
5192 * Bug Reporting:: How to report bugs
5196 @section Have You Found a Bug?
5197 @cindex bug criteria
5199 If you are not sure whether you have found a bug, here are some guidelines:
5202 @cindex fatal signal
5205 If a binary utility gets a fatal signal, for any input whatever, that is
5206 a bug. Reliable utilities never crash.
5208 @cindex error on valid input
5210 If a binary utility produces an error message for valid input, that is a
5214 If you are an experienced user of binary utilities, your suggestions for
5215 improvement are welcome in any case.
5219 @section How to Report Bugs
5221 @cindex bugs, reporting
5223 A number of companies and individuals offer support for @sc{gnu}
5224 products. If you obtained the binary utilities from a support
5225 organization, we recommend you contact that organization first.
5227 You can find contact information for many support companies and
5228 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5232 In any event, we also recommend that you send bug reports for the binary
5233 utilities to @value{BUGURL}.
5236 The fundamental principle of reporting bugs usefully is this:
5237 @strong{report all the facts}. If you are not sure whether to state a
5238 fact or leave it out, state it!
5240 Often people omit facts because they think they know what causes the
5241 problem and assume that some details do not matter. Thus, you might
5242 assume that the name of a file you use in an example does not matter.
5243 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5244 a stray memory reference which happens to fetch from the location where
5245 that pathname is stored in memory; perhaps, if the pathname were
5246 different, the contents of that location would fool the utility into
5247 doing the right thing despite the bug. Play it safe and give a
5248 specific, complete example. That is the easiest thing for you to do,
5249 and the most helpful.
5251 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5252 it is new to us. Therefore, always write your bug reports on the assumption
5253 that the bug has not been reported previously.
5255 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5256 bell?'' This cannot help us fix a bug, so it is basically useless. We
5257 respond by asking for enough details to enable us to investigate.
5258 You might as well expedite matters by sending them to begin with.
5260 To enable us to fix the bug, you should include all these things:
5264 The version of the utility. Each utility announces it if you start it
5265 with the @option{--version} argument.
5267 Without this, we will not know whether there is any point in looking for
5268 the bug in the current version of the binary utilities.
5271 Any patches you may have applied to the source, including any patches
5272 made to the @code{BFD} library.
5275 The type of machine you are using, and the operating system name and
5279 What compiler (and its version) was used to compile the utilities---e.g.
5283 The command arguments you gave the utility to observe the bug. To
5284 guarantee you will not omit something important, list them all. A copy
5285 of the Makefile (or the output from make) is sufficient.
5287 If we were to try to guess the arguments, we would probably guess wrong
5288 and then we might not encounter the bug.
5291 A complete input file, or set of input files, that will reproduce the
5292 bug. If the utility is reading an object file or files, then it is
5293 generally most helpful to send the actual object files.
5295 If the source files were produced exclusively using @sc{gnu} programs
5296 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5297 may be OK to send the source files rather than the object files. In
5298 this case, be sure to say exactly what version of @command{gcc}, or
5299 whatever, was used to produce the object files. Also say how
5300 @command{gcc}, or whatever, was configured.
5303 A description of what behavior you observe that you believe is
5304 incorrect. For example, ``It gets a fatal signal.''
5306 Of course, if the bug is that the utility gets a fatal signal, then we
5307 will certainly notice it. But if the bug is incorrect output, we might
5308 not notice unless it is glaringly wrong. You might as well not give us
5309 a chance to make a mistake.
5311 Even if the problem you experience is a fatal signal, you should still
5312 say so explicitly. Suppose something strange is going on, such as your
5313 copy of the utility is out of sync, or you have encountered a bug in
5314 the C library on your system. (This has happened!) Your copy might
5315 crash and ours would not. If you told us to expect a crash, then when
5316 ours fails to crash, we would know that the bug was not happening for
5317 us. If you had not told us to expect a crash, then we would not be able
5318 to draw any conclusion from our observations.
5321 If you wish to suggest changes to the source, send us context diffs, as
5322 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5323 option. Always send diffs from the old file to the new file. If you
5324 wish to discuss something in the @command{ld} source, refer to it by
5325 context, not by line number.
5327 The line numbers in our development sources will not match those in your
5328 sources. Your line numbers would convey no useful information to us.
5331 Here are some things that are not necessary:
5335 A description of the envelope of the bug.
5337 Often people who encounter a bug spend a lot of time investigating
5338 which changes to the input file will make the bug go away and which
5339 changes will not affect it.
5341 This is often time consuming and not very useful, because the way we
5342 will find the bug is by running a single example under the debugger
5343 with breakpoints, not by pure deduction from a series of examples.
5344 We recommend that you save your time for something else.
5346 Of course, if you can find a simpler example to report @emph{instead}
5347 of the original one, that is a convenience for us. Errors in the
5348 output will be easier to spot, running under the debugger will take
5349 less time, and so on.
5351 However, simplification is not vital; if you do not want to do this,
5352 report the bug anyway and send us the entire test case you used.
5355 A patch for the bug.
5357 A patch for the bug does help us if it is a good one. But do not omit
5358 the necessary information, such as the test case, on the assumption that
5359 a patch is all we need. We might see problems with your patch and decide
5360 to fix the problem another way, or we might not understand it at all.
5362 Sometimes with programs as complicated as the binary utilities it is
5363 very hard to construct an example that will make the program follow a
5364 certain path through the code. If you do not send us the example, we
5365 will not be able to construct one, so we will not be able to verify that
5368 And if we cannot understand what bug you are trying to fix, or why your
5369 patch should be an improvement, we will not install it. A test case will
5370 help us to understand.
5373 A guess about what the bug is or what it depends on.
5375 Such guesses are usually wrong. Even we cannot guess right about such
5376 things without first using the debugger to find the facts.
5379 @node GNU Free Documentation License
5380 @appendix GNU Free Documentation License
5384 @node Binutils Index
5385 @unnumbered Binutils Index