1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2020 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 * debuginfod:: Using binutils with debuginfod
158 * Reporting Bugs:: Reporting Bugs
159 * GNU Free Documentation License:: GNU Free Documentation License
160 * Binutils Index:: Binutils Index
168 @cindex collections of files
170 @c man title ar create, modify, and extract from archives
173 ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
174 ar -M [ <mri-script ]
177 @c man begin DESCRIPTION ar
179 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
180 archives. An @dfn{archive} is a single file holding a collection of
181 other files in a structure that makes it possible to retrieve
182 the original individual files (called @dfn{members} of the archive).
184 The original files' contents, mode (permissions), timestamp, owner, and
185 group are preserved in the archive, and can be restored on
189 @sc{gnu} @command{ar} can maintain archives whose members have names of any
190 length; however, depending on how @command{ar} is configured on your
191 system, a limit on member-name length may be imposed for compatibility
192 with archive formats maintained with other tools. If it exists, the
193 limit is often 15 characters (typical of formats related to a.out) or 16
194 characters (typical of formats related to coff).
197 @command{ar} is considered a binary utility because archives of this sort
198 are most often used as @dfn{libraries} holding commonly needed
202 @command{ar} creates an index to the symbols defined in relocatable
203 object modules in the archive when you specify the modifier @samp{s}.
204 Once created, this index is updated in the archive whenever @command{ar}
205 makes a change to its contents (save for the @samp{q} update operation).
206 An archive with such an index speeds up linking to the library, and
207 allows routines in the library to call each other without regard to
208 their placement in the archive.
210 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
211 table. If an archive lacks the table, another form of @command{ar} called
212 @command{ranlib} can be used to add just the table.
214 @cindex thin archives
215 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
216 which contains a symbol index and references to the original copies
217 of the member files of the archive. This is useful for building
218 libraries for use within a local build tree, where the relocatable
219 objects are expected to remain available, and copying the contents of
220 each object would only waste time and space.
222 An archive can either be @emph{thin} or it can be normal. It cannot
223 be both at the same time. Once an archive is created its format
224 cannot be changed without first deleting it and then creating a new
225 archive in its place.
227 Thin archives are also @emph{flattened}, so that adding one thin
228 archive to another thin archive does not nest it, as would happen with
229 a normal archive. Instead the elements of the first archive are added
230 individually to the second archive.
232 The paths to the elements of the archive are stored relative to the
235 @cindex compatibility, @command{ar}
236 @cindex @command{ar} compatibility
237 @sc{gnu} @command{ar} is designed to be compatible with two different
238 facilities. You can control its activity using command-line options,
239 like the different varieties of @command{ar} on Unix systems; or, if you
240 specify the single command-line option @option{-M}, you can control it
241 with a script supplied via standard input, like the MRI ``librarian''
247 * ar cmdline:: Controlling @command{ar} on the command line
248 * ar scripts:: Controlling @command{ar} with a script
253 @section Controlling @command{ar} on the Command Line
256 @c man begin SYNOPSIS ar
257 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
261 @cindex Unix compatibility, @command{ar}
262 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
263 arguments to execute: one keyletter specifying the @emph{operation}
264 (optionally accompanied by other keyletters specifying
265 @emph{modifiers}), and the archive name to act on.
267 Most operations can also accept further @var{member} arguments,
268 specifying particular files to operate on.
270 @c man begin OPTIONS ar
272 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
273 flags @var{mod} in any order, within the first command-line argument.
275 If you wish, you may begin the first command-line argument with a
278 @cindex operations on archive
279 The @var{p} keyletter specifies what operation to execute; it may be
280 any of the following, but you must specify only one of them:
284 @cindex deleting from archive
285 @emph{Delete} modules from the archive. Specify the names of modules to
286 be deleted as @var{member}@dots{}; the archive is untouched if you
287 specify no files to delete.
289 If you specify the @samp{v} modifier, @command{ar} lists each module
293 @cindex moving in archive
294 Use this operation to @emph{move} members in an archive.
296 The ordering of members in an archive can make a difference in how
297 programs are linked using the library, if a symbol is defined in more
300 If no modifiers are used with @code{m}, any members you name in the
301 @var{member} arguments are moved to the @emph{end} of the archive;
302 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
303 specified place instead.
306 @cindex printing from archive
307 @emph{Print} the specified members of the archive, to the standard
308 output file. If the @samp{v} modifier is specified, show the member
309 name before copying its contents to standard output.
311 If you specify no @var{member} arguments, all the files in the archive are
315 @cindex quick append to archive
316 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
317 @var{archive}, without checking for replacement.
319 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
320 operation; new members are always placed at the end of the archive.
322 The modifier @samp{v} makes @command{ar} list each file as it is appended.
324 Since the point of this operation is speed, implementations of
325 @command{ar} have the option of not updating the archive's symbol
326 table if one exists. Too many different systems however assume that
327 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
328 rebuild the table even with a quick append.
330 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
331 synonym for @samp{r} - replacing already existing files in the
332 archive and appending new ones at the end.
335 @cindex replacement in archive
336 Insert the files @var{member}@dots{} into @var{archive} (with
337 @emph{replacement}). This operation differs from @samp{q} in that any
338 previously existing members are deleted if their names match those being
341 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
342 displays an error message, and leaves undisturbed any existing members
343 of the archive matching that name.
345 By default, new members are added at the end of the file; but you may
346 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
347 placement relative to some existing member.
349 The modifier @samp{v} used with this operation elicits a line of
350 output for each file inserted, along with one of the letters @samp{a} or
351 @samp{r} to indicate whether the file was appended (no old member
352 deleted) or replaced.
356 Add an index to the archive, or update it if it already exists. Note
357 this command is an exception to the rule that there can only be one
358 command letter, as it is possible to use it as either a command or a
359 modifier. In either case it does the same thing.
362 @cindex contents of archive
363 Display a @emph{table} listing the contents of @var{archive}, or those
364 of the files listed in @var{member}@dots{} that are present in the
365 archive. Normally only the member name is shown, but if the modifier
366 @samp{O} is specified, then the corresponding offset of the member is also
367 displayed. Finally, in order to see the modes (permissions), timestamp,
368 owner, group, and size the @samp{v} modifier should be included.
370 If you do not specify a @var{member}, all files in the archive
373 @cindex repeated names in archive
374 @cindex name duplication in archive
375 If there is more than one file with the same name (say, @samp{fie}) in
376 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
377 first instance; to see them all, you must ask for a complete
378 listing---in our example, @samp{ar t b.a}.
379 @c WRS only; per Gumby, this is implementation-dependent, and in a more
380 @c recent case in fact works the other way.
383 @cindex extract from archive
384 @emph{Extract} members (named @var{member}) from the archive. You can
385 use the @samp{v} modifier with this operation, to request that
386 @command{ar} list each name as it extracts it.
388 If you do not specify a @var{member}, all files in the archive
391 Files cannot be extracted from a thin archive, and there are
392 restrictions on extracting from archives created with @option{P}: The
393 paths must not be absolute, may not contain @code{..}, and any
394 subdirectories in the paths must exist. If it is desired to avoid
395 these restrictions then used the @option{--output} option to specify
399 A number of modifiers (@var{mod}) may immediately follow the @var{p}
400 keyletter, to specify variations on an operation's behavior:
404 @cindex relative placement in archive
405 Add new files @emph{after} an existing member of the
406 archive. If you use the modifier @samp{a}, the name of an existing archive
407 member must be present as the @var{relpos} argument, before the
408 @var{archive} specification.
411 Add new files @emph{before} an existing member of the
412 archive. If you use the modifier @samp{b}, the name of an existing archive
413 member must be present as the @var{relpos} argument, before the
414 @var{archive} specification. (same as @samp{i}).
417 @cindex creating archives
418 @emph{Create} the archive. The specified @var{archive} is always
419 created if it did not exist, when you request an update. But a warning is
420 issued unless you specify in advance that you expect to create it, by
424 @cindex deterministic archives
425 @kindex --enable-deterministic-archives
426 Operate in @emph{deterministic} mode. When adding files and the archive
427 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
428 for all files. When this option is used, if @command{ar} is used with
429 identical options and identical input files, multiple runs will create
430 identical output files regardless of the input files' owners, groups,
431 file modes, or modification times.
433 If @file{binutils} was configured with
434 @option{--enable-deterministic-archives}, then this mode is on by default.
435 It can be disabled with the @samp{U} modifier, below.
438 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
439 names of any length. This will cause it to create archives which are
440 not compatible with the native @command{ar} program on some systems. If
441 this is a concern, the @samp{f} modifier may be used to truncate file
442 names when putting them in the archive.
445 Insert new files @emph{before} an existing member of the
446 archive. If you use the modifier @samp{i}, the name of an existing archive
447 member must be present as the @var{relpos} argument, before the
448 @var{archive} specification. (same as @samp{b}).
451 This modifier is accepted but not used.
452 @c whaffor ar l modifier??? presumably compat; with
453 @c what???---doc@@cygnus.com, 25jan91
456 Uses the @var{count} parameter. This is used if there are multiple
457 entries in the archive with the same name. Extract or delete instance
458 @var{count} of the given name from the archive.
461 @cindex dates in archive
462 Preserve the @emph{original} dates of members when extracting them. If
463 you do not specify this modifier, files extracted from the archive
464 are stamped with the time of extraction.
467 @cindex offsets of files
468 Display member offsets inside the archive. Use together with the @samp{t}
472 Use the full path name when matching or storing names in the archive.
473 Archives created with full path names are not POSIX compliant, and
474 thus may not work with tools other than up to date @sc{gnu} tools.
475 Modifying such archives with @sc{gnu} @command{ar} without using
476 @option{P} will remove the full path names unless the archive is a
477 thin archive. Note that @option{P} may be useful when adding files to
478 a thin archive since @option{r} without @option{P} ignores the path
479 when choosing which element to replace. Thus
481 ar rcST archive.a subdir/file1 subdir/file2 file1
483 will result in the first @code{subdir/file1} being replaced with
484 @code{file1} from the current directory. Adding @option{P} will
485 prevent this replacement.
488 @cindex writing archive index
489 Write an object-file index into the archive, or update an existing one,
490 even if no other change is made to the archive. You may use this modifier
491 flag either with any operation, or alone. Running @samp{ar s} on an
492 archive is equivalent to running @samp{ranlib} on it.
495 @cindex not writing archive index
496 Do not generate an archive symbol table. This can speed up building a
497 large library in several steps. The resulting archive can not be used
498 with the linker. In order to build a symbol table, you must omit the
499 @samp{S} modifier on the last execution of @samp{ar}, or you must run
500 @samp{ranlib} on the archive.
503 @cindex creating thin archive
504 Make the specified @var{archive} a @emph{thin} archive. If it already
505 exists and is a regular archive, the existing members must be present
506 in the same directory as @var{archive}.
509 @cindex updating an archive
510 Normally, @samp{ar r}@dots{} inserts all files
511 listed into the archive. If you would like to insert @emph{only} those
512 of the files you list that are newer than existing members of the same
513 names, use this modifier. The @samp{u} modifier is allowed only for the
514 operation @samp{r} (replace). In particular, the combination @samp{qu} is
515 not allowed, since checking the timestamps would lose any speed
516 advantage from the operation @samp{q}.
519 @cindex deterministic archives
520 @kindex --enable-deterministic-archives
521 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
522 of the @samp{D} modifier, above: added files and the archive index will
523 get their actual UID, GID, timestamp, and file mode values.
525 This is the default unless @file{binutils} was configured with
526 @option{--enable-deterministic-archives}.
529 This modifier requests the @emph{verbose} version of an operation. Many
530 operations display additional information, such as filenames processed,
531 when the modifier @samp{v} is appended.
534 This modifier shows the version number of @command{ar}.
537 The @command{ar} program also supports some command-line options which
538 are neither modifiers nor actions, but which do change its behaviour
543 Displays the list of command-line options supported by @command{ar}
547 Displays the version information of @command{ar} and then exits.
550 @command{ar} ignores an initial option spelled @samp{-X32_64}, for
551 compatibility with AIX. The behaviour produced by this option is the
552 default for @sc{gnu} @command{ar}. @command{ar} does not support any
553 of the other @samp{-X} options; in particular, it does not support
554 @option{-X32} which is the default for AIX @command{ar}.
556 @item --plugin @var{name}
558 The optional command-line switch @option{--plugin @var{name}} causes
559 @command{ar} to load the plugin called @var{name} which adds support
560 for more file formats, including object files with link-time
561 optimization information.
563 This option is only available if the toolchain has been built with
564 plugin support enabled.
566 If @option{--plugin} is not provided, but plugin support has been
567 enabled then @command{ar} iterates over the files in
568 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
569 plugin that claims the object in question is used.
571 Please note that this plugin search directory is @emph{not} the one
572 used by @command{ld}'s @option{-plugin} option. In order to make
573 @command{ar} use the linker plugin it must be copied into the
574 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
575 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
576 based compilations it is called @file{LLVMgold.so}. The GCC plugin
577 is always backwards compatible with earlier versions, so it is
578 sufficient to just copy the newest one.
580 @item --target @var{target}
581 The optional command-line switch @option{--target @var{bfdname}}
582 specifies that the archive members are in an object code format
583 different from your system's default format. See
584 @xref{Target Selection}, for more information.
586 @item --output @var{dirname}
587 The @option{--output} option can be used to specify a path to a
588 directory into which archive members should be extracted. If this
589 option is not specified then the current directory will be used.
591 Note - although the presence of this option does imply a @option{x}
592 extraction operation that option must still be included on the command
599 @c man begin SEEALSO ar
600 nm(1), ranlib(1), and the Info entries for @file{binutils}.
605 @section Controlling @command{ar} with a Script
608 ar -M [ <@var{script} ]
611 @cindex MRI compatibility, @command{ar}
612 @cindex scripts, @command{ar}
613 If you use the single command-line option @samp{-M} with @command{ar}, you
614 can control its operation with a rudimentary command language. This
615 form of @command{ar} operates interactively if standard input is coming
616 directly from a terminal. During interactive use, @command{ar} prompts for
617 input (the prompt is @samp{AR >}), and continues executing even after
618 errors. If you redirect standard input to a script file, no prompts are
619 issued, and @command{ar} abandons execution (with a nonzero exit code)
622 The @command{ar} command language is @emph{not} designed to be equivalent
623 to the command-line options; in fact, it provides somewhat less control
624 over archives. The only purpose of the command language is to ease the
625 transition to @sc{gnu} @command{ar} for developers who already have scripts
626 written for the MRI ``librarian'' program.
628 The syntax for the @command{ar} command language is straightforward:
631 commands are recognized in upper or lower case; for example, @code{LIST}
632 is the same as @code{list}. In the following descriptions, commands are
633 shown in upper case for clarity.
636 a single command may appear on each line; it is the first word on the
640 empty lines are allowed, and have no effect.
643 comments are allowed; text after either of the characters @samp{*}
644 or @samp{;} is ignored.
647 Whenever you use a list of names as part of the argument to an @command{ar}
648 command, you can separate the individual names with either commas or
649 blanks. Commas are shown in the explanations below, for clarity.
652 @samp{+} is used as a line continuation character; if @samp{+} appears
653 at the end of a line, the text on the following line is considered part
654 of the current command.
657 Here are the commands you can use in @command{ar} scripts, or when using
658 @command{ar} interactively. Three of them have special significance:
660 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
661 a temporary file required for most of the other commands.
663 @code{SAVE} commits the changes so far specified by the script. Prior
664 to @code{SAVE}, commands affect only the temporary copy of the current
668 @item ADDLIB @var{archive}
669 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
670 Add all the contents of @var{archive} (or, if specified, each named
671 @var{module} from @var{archive}) to the current archive.
673 Requires prior use of @code{OPEN} or @code{CREATE}.
675 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
676 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
677 @c else like "ar q..."
678 Add each named @var{member} as a module in the current archive.
680 Requires prior use of @code{OPEN} or @code{CREATE}.
683 Discard the contents of the current archive, canceling the effect of
684 any operations since the last @code{SAVE}. May be executed (with no
685 effect) even if no current archive is specified.
687 @item CREATE @var{archive}
688 Creates an archive, and makes it the current archive (required for many
689 other commands). The new archive is created with a temporary name; it
690 is not actually saved as @var{archive} until you use @code{SAVE}.
691 You can overwrite existing archives; similarly, the contents of any
692 existing file named @var{archive} will not be destroyed until @code{SAVE}.
694 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
695 Delete each listed @var{module} from the current archive; equivalent to
696 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
698 Requires prior use of @code{OPEN} or @code{CREATE}.
700 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
701 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
702 List each named @var{module} present in @var{archive}. The separate
703 command @code{VERBOSE} specifies the form of the output: when verbose
704 output is off, output is like that of @samp{ar -t @var{archive}
705 @var{module}@dots{}}. When verbose output is on, the listing is like
706 @samp{ar -tv @var{archive} @var{module}@dots{}}.
708 Output normally goes to the standard output stream; however, if you
709 specify @var{outputfile} as a final argument, @command{ar} directs the
713 Exit from @command{ar}, with a @code{0} exit code to indicate successful
714 completion. This command does not save the output file; if you have
715 changed the current archive since the last @code{SAVE} command, those
718 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
719 Extract each named @var{module} from the current archive, writing them
720 into the current directory as separate files. Equivalent to @samp{ar -x
721 @var{archive} @var{module}@dots{}}.
723 Requires prior use of @code{OPEN} or @code{CREATE}.
726 @c FIXME Tokens but no commands???
733 Display full contents of the current archive, in ``verbose'' style
734 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
735 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
736 enhancement, rather than present for MRI compatibility.)
738 Requires prior use of @code{OPEN} or @code{CREATE}.
740 @item OPEN @var{archive}
741 Opens an existing archive for use as the current archive (required for
742 many other commands). Any changes as the result of subsequent commands
743 will not actually affect @var{archive} until you next use @code{SAVE}.
745 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
746 In the current archive, replace each existing @var{module} (named in
747 the @code{REPLACE} arguments) from files in the current working directory.
748 To execute this command without errors, both the file, and the module in
749 the current archive, must exist.
751 Requires prior use of @code{OPEN} or @code{CREATE}.
754 Toggle an internal flag governing the output from @code{DIRECTORY}.
755 When the flag is on, @code{DIRECTORY} output matches output from
756 @samp{ar -tv }@dots{}.
759 Commit your changes to the current archive, and actually save it as a
760 file with the name specified in the last @code{CREATE} or @code{OPEN}
763 Requires prior use of @code{OPEN} or @code{CREATE}.
772 The @sc{gnu} linker @command{ld} is now described in a separate manual.
773 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
781 @c man title nm list symbols from object files
784 @c man begin SYNOPSIS nm
785 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
786 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
787 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
788 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
789 [@option{-l}|@option{--line-numbers}] [@option{--inlines}]
790 [@option{-n}|@option{-v}|@option{--numeric-sort}]
791 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
792 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
793 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
794 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
795 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
796 [@option{--plugin} @var{name}]
797 [@option{--no-recurse-limit}|@option{--recurse-limit}]]
798 [@option{--size-sort}] [@option{--special-syms}]
799 [@option{--synthetic}] [@option{--target=}@var{bfdname}]
800 [@var{objfile}@dots{}]
804 @c man begin DESCRIPTION nm
805 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
806 If no object files are listed as arguments, @command{nm} assumes the file
809 For each symbol, @command{nm} shows:
813 The symbol value, in the radix selected by options (see below), or
814 hexadecimal by default.
817 The symbol type. At least the following types are used; others are, as
818 well, depending on the object file format. If lowercase, the symbol is
819 usually local; if uppercase, the symbol is global (external). There
820 are however a few lowercase symbols that are shown for special global
821 symbols (@code{u}, @code{v} and @code{w}).
823 @c Some more detail on exactly what these symbol types are used for
827 The symbol's value is absolute, and will not be changed by further
832 The symbol is in the BSS data section. This section typically
833 contains zero-initialized or uninitialized data, although the exact
834 behavior is system dependent.
837 The symbol is common. Common symbols are uninitialized data. When
838 linking, multiple common symbols may appear with the same name. If the
839 symbol is defined anywhere, the common symbols are treated as undefined
842 For more details on common symbols, see the discussion of
843 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
848 The symbol is in the initialized data section.
852 The symbol is in an initialized data section for small objects. Some
853 object file formats permit more efficient access to small data objects,
854 such as a global int variable as opposed to a large global array.
857 For PE format files this indicates that the symbol is in a section
858 specific to the implementation of DLLs. For ELF format files this
859 indicates that the symbol is an indirect function. This is a GNU
860 extension to the standard set of ELF symbol types. It indicates a
861 symbol which if referenced by a relocation does not evaluate to its
862 address, but instead must be invoked at runtime. The runtime
863 execution will then return the value to be used in the relocation.
866 The symbol is an indirect reference to another symbol.
869 The symbol is a debugging symbol.
872 The symbol is in the read-only data section.
875 The symbol is in a stack unwind section.
879 The symbol is in a read only data section.
883 The symbol is in an uninitialized or zero-initialized data section
888 The symbol is in the text (code) section.
891 The symbol is undefined.
894 The symbol is a unique global symbol. This is a GNU extension to the
895 standard set of ELF symbol bindings. For such a symbol the dynamic linker
896 will make sure that in the entire process there is just one symbol with
897 this name and type in use.
901 The symbol is a weak object. When a weak defined symbol is linked with
902 a normal defined symbol, the normal defined symbol is used with no error.
903 When a weak undefined symbol is linked and the symbol is not defined,
904 the value of the weak symbol becomes zero with no error. On some
905 systems, uppercase indicates that a default value has been specified.
909 The symbol is a weak symbol that has not been specifically tagged as a
910 weak object symbol. When a weak defined symbol is linked with a normal
911 defined symbol, the normal defined symbol is used with no error.
912 When a weak undefined symbol is linked and the symbol is not defined,
913 the value of the symbol is determined in a system-specific manner without
914 error. On some systems, uppercase indicates that a default value has been
918 The symbol is a stabs symbol in an a.out object file. In this case, the
919 next values printed are the stabs other field, the stabs desc field, and
920 the stab type. Stabs symbols are used to hold debugging information.
923 The symbol type is unknown, or object file format specific.
932 @c man begin OPTIONS nm
933 The long and short forms of options, shown here as alternatives, are
939 @itemx --print-file-name
940 @cindex input file name
942 @cindex source file name
943 Precede each symbol by the name of the input file (or archive member)
944 in which it was found, rather than identifying the input file once only,
945 before all of its symbols.
949 @cindex debugging symbols
950 Display all symbols, even debugger-only symbols; normally these are not
954 @cindex @command{nm} format
955 @cindex @command{nm} compatibility
956 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
959 @itemx --demangle[=@var{style}]
960 @cindex demangling in nm
961 Decode (@dfn{demangle}) low-level symbol names into user-level names.
962 Besides removing any initial underscore prepended by the system, this
963 makes C++ function names readable. Different compilers have different
964 mangling styles. The optional demangling style argument can be used to
965 choose an appropriate demangling style for your compiler. @xref{c++filt},
966 for more information on demangling.
969 Do not demangle low-level symbol names. This is the default.
971 @item --recurse-limit
972 @itemx --no-recurse-limit
973 @itemx --recursion-limit
974 @itemx --no-recursion-limit
975 Enables or disables a limit on the amount of recursion performed
976 whilst demangling strings. Since the name mangling formats allow for
977 an inifinite level of recursion it is possible to create strings whose
978 decoding will exhaust the amount of stack space available on the host
979 machine, triggering a memory fault. The limit tries to prevent this
980 from happening by restricting recursion to 2048 levels of nesting.
982 The default is for this limit to be enabled, but disabling it may be
983 necessary in order to demangle truly complicated names. Note however
984 that if the recursion limit is disabled then stack exhaustion is
985 possible and any bug reports about such an event will be rejected.
989 @cindex dynamic symbols
990 Display the dynamic symbols rather than the normal symbols. This is
991 only meaningful for dynamic objects, such as certain types of shared
994 @item -f @var{format}
995 @itemx --format=@var{format}
996 @cindex @command{nm} format
997 @cindex @command{nm} compatibility
998 Use the output format @var{format}, which can be @code{bsd},
999 @code{sysv}, or @code{posix}. The default is @code{bsd}.
1000 Only the first character of @var{format} is significant; it can be
1001 either upper or lower case.
1004 @itemx --extern-only
1005 @cindex external symbols
1006 Display only external symbols.
1010 Show a summary of the options to @command{nm} and exit.
1013 @itemx --line-numbers
1014 @cindex symbol line numbers
1015 For each symbol, use debugging information to try to find a filename and
1016 line number. For a defined symbol, look for the line number of the
1017 address of the symbol. For an undefined symbol, look for the line
1018 number of a relocation entry which refers to the symbol. If line number
1019 information can be found, print it after the other symbol information.
1022 @cindex objdump inlines
1023 When option @option{-l} is active, if the address belongs to a
1024 function that was inlined, then this option causes the source
1025 information for all enclosing scopes back to the first non-inlined
1026 function to be printed as well. For example, if @code{main} inlines
1027 @code{callee1} which inlines @code{callee2}, and address is from
1028 @code{callee2}, the source information for @code{callee1} and @code{main}
1029 will also be printed.
1033 @itemx --numeric-sort
1034 Sort symbols numerically by their addresses, rather than alphabetically
1039 @cindex sorting symbols
1040 Do not bother to sort the symbols in any order; print them in the order
1044 @itemx --portability
1045 Use the POSIX.2 standard output format instead of the default format.
1046 Equivalent to @samp{-f posix}.
1049 @itemx --reverse-sort
1050 Reverse the order of the sort (whether numeric or alphabetic); let the
1055 Print both value and size of defined symbols for the @code{bsd} output style.
1056 This option has no effect for object formats that do not record symbol
1057 sizes, unless @samp{--size-sort} is also used in which case a
1058 calculated size is displayed.
1061 @itemx --print-armap
1062 @cindex symbol index, listing
1063 When listing symbols from archive members, include the index: a mapping
1064 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
1065 contain definitions for which names.
1067 @item -t @var{radix}
1068 @itemx --radix=@var{radix}
1069 Use @var{radix} as the radix for printing the symbol values. It must be
1070 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
1073 @itemx --undefined-only
1074 @cindex external symbols
1075 @cindex undefined symbols
1076 Display only undefined symbols (those external to each object file).
1080 Show the version number of @command{nm} and exit.
1083 This option is ignored for compatibility with the AIX version of
1084 @command{nm}. It takes one parameter which must be the string
1085 @option{32_64}. The default mode of AIX @command{nm} corresponds
1086 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1088 @item --defined-only
1089 @cindex external symbols
1090 @cindex undefined symbols
1091 Display only defined symbols for each object file.
1093 @item --plugin @var{name}
1095 Load the plugin called @var{name} to add support for extra target
1096 types. This option is only available if the toolchain has been built
1097 with plugin support enabled.
1099 If @option{--plugin} is not provided, but plugin support has been
1100 enabled then @command{nm} iterates over the files in
1101 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
1102 plugin that claims the object in question is used.
1104 Please note that this plugin search directory is @emph{not} the one
1105 used by @command{ld}'s @option{-plugin} option. In order to make
1106 @command{nm} use the linker plugin it must be copied into the
1107 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
1108 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
1109 based compilations it is called @file{LLVMgold.so}. The GCC plugin
1110 is always backwards compatible with earlier versions, so it is
1111 sufficient to just copy the newest one.
1114 Sort symbols by size. For ELF objects symbol sizes are read from the
1115 ELF, for other object types the symbol sizes are computed as the
1116 difference between the value of the symbol and the value of the symbol
1117 with the next higher value. If the @code{bsd} output format is used
1118 the size of the symbol is printed, rather than the value, and
1119 @samp{-S} must be used in order both size and value to be printed.
1121 @item --special-syms
1122 Display symbols which have a target-specific special meaning. These
1123 symbols are usually used by the target for some special processing and
1124 are not normally helpful when included in the normal symbol lists.
1125 For example for ARM targets this option would skip the mapping symbols
1126 used to mark transitions between ARM code, THUMB code and data.
1129 Include synthetic symbols in the output. These are special symbols
1130 created by the linker for various purposes. They are not shown by
1131 default since they are not part of the binary's original source code.
1133 @item --target=@var{bfdname}
1134 @cindex object code format
1135 Specify an object code format other than your system's default format.
1136 @xref{Target Selection}, for more information.
1143 @c man begin SEEALSO nm
1144 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1151 @c man title objcopy copy and translate object files
1154 @c man begin SYNOPSIS objcopy
1155 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1156 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1157 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1158 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1159 [@option{-S}|@option{--strip-all}]
1160 [@option{-g}|@option{--strip-debug}]
1161 [@option{--strip-unneeded}]
1162 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1163 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1164 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1165 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1166 [@option{--localize-hidden}]
1167 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1168 [@option{--globalize-symbol=}@var{symbolname}]
1169 [@option{--globalize-symbols=}@var{filename}]
1170 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1171 [@option{-w}|@option{--wildcard}]
1172 [@option{-x}|@option{--discard-all}]
1173 [@option{-X}|@option{--discard-locals}]
1174 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1175 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1176 [@option{--interleave-width=}@var{width}]
1177 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1178 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1179 [@option{--keep-section=}@var{sectionpattern}]
1180 [@option{--remove-relocations=}@var{sectionpattern}]
1181 [@option{-p}|@option{--preserve-dates}]
1182 [@option{-D}|@option{--enable-deterministic-archives}]
1183 [@option{-U}|@option{--disable-deterministic-archives}]
1184 [@option{--debugging}]
1185 [@option{--gap-fill=}@var{val}]
1186 [@option{--pad-to=}@var{address}]
1187 [@option{--set-start=}@var{val}]
1188 [@option{--adjust-start=}@var{incr}]
1189 [@option{--change-addresses=}@var{incr}]
1190 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1191 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1192 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1193 [@option{--change-warnings}] [@option{--no-change-warnings}]
1194 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1195 [@option{--set-section-alignment} @var{sectionpattern}=@var{align}]
1196 [@option{--add-section} @var{sectionname}=@var{filename}]
1197 [@option{--dump-section} @var{sectionname}=@var{filename}]
1198 [@option{--update-section} @var{sectionname}=@var{filename}]
1199 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1200 [@option{--long-section-names} @{enable,disable,keep@}]
1201 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1202 [@option{--reverse-bytes=}@var{num}]
1203 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1204 [@option{--redefine-sym} @var{old}=@var{new}]
1205 [@option{--redefine-syms=}@var{filename}]
1207 [@option{--keep-symbols=}@var{filename}]
1208 [@option{--strip-symbols=}@var{filename}]
1209 [@option{--strip-unneeded-symbols=}@var{filename}]
1210 [@option{--keep-global-symbols=}@var{filename}]
1211 [@option{--localize-symbols=}@var{filename}]
1212 [@option{--weaken-symbols=}@var{filename}]
1213 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]]
1214 [@option{--alt-machine-code=}@var{index}]
1215 [@option{--prefix-symbols=}@var{string}]
1216 [@option{--prefix-sections=}@var{string}]
1217 [@option{--prefix-alloc-sections=}@var{string}]
1218 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1219 [@option{--keep-file-symbols}]
1220 [@option{--only-keep-debug}]
1221 [@option{--strip-dwo}]
1222 [@option{--extract-dwo}]
1223 [@option{--extract-symbol}]
1224 [@option{--writable-text}]
1225 [@option{--readonly-text}]
1228 [@option{--file-alignment=}@var{num}]
1229 [@option{--heap=}@var{size}]
1230 [@option{--image-base=}@var{address}]
1231 [@option{--section-alignment=}@var{num}]
1232 [@option{--stack=}@var{size}]
1233 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1234 [@option{--compress-debug-sections}]
1235 [@option{--decompress-debug-sections}]
1236 [@option{--elf-stt-common=@var{val}}]
1237 [@option{--merge-notes}]
1238 [@option{--no-merge-notes}]
1239 [@option{--verilog-data-width=@var{val}}]
1240 [@option{-v}|@option{--verbose}]
1241 [@option{-V}|@option{--version}]
1242 [@option{--help}] [@option{--info}]
1243 @var{infile} [@var{outfile}]
1247 @c man begin DESCRIPTION objcopy
1248 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1249 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1250 read and write the object files. It can write the destination object
1251 file in a format different from that of the source object file. The
1252 exact behavior of @command{objcopy} is controlled by command-line options.
1253 Note that @command{objcopy} should be able to copy a fully linked file
1254 between any two formats. However, copying a relocatable object file
1255 between any two formats may not work as expected.
1257 @command{objcopy} creates temporary files to do its translations and
1258 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1259 translation work; it has access to all the formats described in @sc{bfd}
1260 and thus is able to recognize most formats without being told
1261 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1263 @command{objcopy} can be used to generate S-records by using an output
1264 target of @samp{srec} (e.g., use @samp{-O srec}).
1266 @command{objcopy} can be used to generate a raw binary file by using an
1267 output target of @samp{binary} (e.g., use @option{-O binary}). When
1268 @command{objcopy} generates a raw binary file, it will essentially produce
1269 a memory dump of the contents of the input object file. All symbols and
1270 relocation information will be discarded. The memory dump will start at
1271 the load address of the lowest section copied into the output file.
1273 When generating an S-record or a raw binary file, it may be helpful to
1274 use @option{-S} to remove sections containing debugging information. In
1275 some cases @option{-R} will be useful to remove sections which contain
1276 information that is not needed by the binary file.
1278 Note---@command{objcopy} is not able to change the endianness of its input
1279 files. If the input format has an endianness (some formats do not),
1280 @command{objcopy} can only copy the inputs into file formats that have the
1281 same endianness or which have no endianness (e.g., @samp{srec}).
1282 (However, see the @option{--reverse-bytes} option.)
1286 @c man begin OPTIONS objcopy
1290 @itemx @var{outfile}
1291 The input and output files, respectively.
1292 If you do not specify @var{outfile}, @command{objcopy} creates a
1293 temporary file and destructively renames the result with
1294 the name of @var{infile}.
1296 @item -I @var{bfdname}
1297 @itemx --input-target=@var{bfdname}
1298 Consider the source file's object format to be @var{bfdname}, rather than
1299 attempting to deduce it. @xref{Target Selection}, for more information.
1301 @item -O @var{bfdname}
1302 @itemx --output-target=@var{bfdname}
1303 Write the output file using the object format @var{bfdname}.
1304 @xref{Target Selection}, for more information.
1306 @item -F @var{bfdname}
1307 @itemx --target=@var{bfdname}
1308 Use @var{bfdname} as the object format for both the input and the output
1309 file; i.e., simply transfer data from source to destination with no
1310 translation. @xref{Target Selection}, for more information.
1312 @item -B @var{bfdarch}
1313 @itemx --binary-architecture=@var{bfdarch}
1314 Useful when transforming a architecture-less input file into an object file.
1315 In this case the output architecture can be set to @var{bfdarch}. This
1316 option will be ignored if the input file has a known @var{bfdarch}. You
1317 can access this binary data inside a program by referencing the special
1318 symbols that are created by the conversion process. These symbols are
1319 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1320 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1321 an object file and then access it in your code using these symbols.
1323 @item -j @var{sectionpattern}
1324 @itemx --only-section=@var{sectionpattern}
1325 Copy only the indicated sections from the input file to the output file.
1326 This option may be given more than once. Note that using this option
1327 inappropriately may make the output file unusable. Wildcard
1328 characters are accepted in @var{sectionpattern}.
1330 If the first character of @var{sectionpattern} is the exclamation
1331 point (!) then matching sections will not be copied, even if earlier
1332 use of @option{--only-section} on the same command line would
1333 otherwise copy it. For example:
1336 --only-section=.text.* --only-section=!.text.foo
1339 will copy all sectinos maching '.text.*' but not the section
1342 @item -R @var{sectionpattern}
1343 @itemx --remove-section=@var{sectionpattern}
1344 Remove any section matching @var{sectionpattern} from the output file.
1345 This option may be given more than once. Note that using this option
1346 inappropriately may make the output file unusable. Wildcard
1347 characters are accepted in @var{sectionpattern}. Using both the
1348 @option{-j} and @option{-R} options together results in undefined
1351 If the first character of @var{sectionpattern} is the exclamation
1352 point (!) then matching sections will not be removed even if an
1353 earlier use of @option{--remove-section} on the same command line
1354 would otherwise remove it. For example:
1357 --remove-section=.text.* --remove-section=!.text.foo
1360 will remove all sections matching the pattern '.text.*', but will not
1361 remove the section '.text.foo'.
1363 @item --keep-section=@var{sectionpattern}
1364 When removing sections from the output file, keep sections that match
1365 @var{sectionpattern}.
1367 @item --remove-relocations=@var{sectionpattern}
1368 Remove non-dynamic relocations from the output file for any section
1369 matching @var{sectionpattern}. This option may be given more than
1370 once. Note that using this option inappropriately may make the output
1371 file unusable, and attempting to remove a dynamic relocation section
1372 such as @samp{.rela.plt} from an executable or shared library with
1373 @option{--remove-relocations=.plt} will not work. Wildcard characters
1374 are accepted in @var{sectionpattern}.
1378 --remove-relocations=.text.*
1381 will remove the relocations for all sections matching the pattern
1384 If the first character of @var{sectionpattern} is the exclamation
1385 point (!) then matching sections will not have their relocation
1386 removed even if an earlier use of @option{--remove-relocations} on the
1387 same command line would otherwise cause the relocations to be removed.
1391 --remove-relocations=.text.* --remove-relocations=!.text.foo
1394 will remove all relocations for sections matching the pattern
1395 '.text.*', but will not remove relocations for the section
1400 Do not copy relocation and symbol information from the source file.
1403 @itemx --strip-debug
1404 Do not copy debugging symbols or sections from the source file.
1406 @item --strip-unneeded
1407 Strip all symbols that are not needed for relocation processing.
1409 @item -K @var{symbolname}
1410 @itemx --keep-symbol=@var{symbolname}
1411 When stripping symbols, keep symbol @var{symbolname} even if it would
1412 normally be stripped. This option may be given more than once.
1414 @item -N @var{symbolname}
1415 @itemx --strip-symbol=@var{symbolname}
1416 Do not copy symbol @var{symbolname} from the source file. This option
1417 may be given more than once.
1419 @item --strip-unneeded-symbol=@var{symbolname}
1420 Do not copy symbol @var{symbolname} from the source file unless it is needed
1421 by a relocation. This option may be given more than once.
1423 @item -G @var{symbolname}
1424 @itemx --keep-global-symbol=@var{symbolname}
1425 Keep only symbol @var{symbolname} global. Make all other symbols local
1426 to the file, so that they are not visible externally. This option may
1427 be given more than once. Note: this option cannot be used in
1428 conjunction with the @option{--globalize-symbol} or
1429 @option{--globalize-symbols} options.
1431 @item --localize-hidden
1432 In an ELF object, mark all symbols that have hidden or internal visibility
1433 as local. This option applies on top of symbol-specific localization options
1434 such as @option{-L}.
1436 @item -L @var{symbolname}
1437 @itemx --localize-symbol=@var{symbolname}
1438 Convert a global or weak symbol called @var{symbolname} into a local
1439 symbol, so that it is not visible externally. This option may be
1440 given more than once. Note - unique symbols are not converted.
1442 @item -W @var{symbolname}
1443 @itemx --weaken-symbol=@var{symbolname}
1444 Make symbol @var{symbolname} weak. This option may be given more than once.
1446 @item --globalize-symbol=@var{symbolname}
1447 Give symbol @var{symbolname} global scoping so that it is visible
1448 outside of the file in which it is defined. This option may be given
1449 more than once. Note: this option cannot be used in conjunction with
1450 the @option{-G} or @option{--keep-global-symbol} options.
1454 Permit regular expressions in @var{symbolname}s used in other command
1455 line options. The question mark (?), asterisk (*), backslash (\) and
1456 square brackets ([]) operators can be used anywhere in the symbol
1457 name. If the first character of the symbol name is the exclamation
1458 point (!) then the sense of the switch is reversed for that symbol.
1465 would cause objcopy to weaken all symbols that start with ``fo''
1466 except for the symbol ``foo''.
1469 @itemx --discard-all
1470 Do not copy non-global symbols from the source file.
1471 @c FIXME any reason to prefer "non-global" to "local" here?
1474 @itemx --discard-locals
1475 Do not copy compiler-generated local symbols.
1476 (These usually start with @samp{L} or @samp{.}.)
1479 @itemx --byte=@var{byte}
1480 If interleaving has been enabled via the @option{--interleave} option
1481 then start the range of bytes to keep at the @var{byte}th byte.
1482 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1483 @var{breadth} is the value given by the @option{--interleave} option.
1485 @item -i [@var{breadth}]
1486 @itemx --interleave[=@var{breadth}]
1487 Only copy a range out of every @var{breadth} bytes. (Header data is
1488 not affected). Select which byte in the range begins the copy with
1489 the @option{--byte} option. Select the width of the range with the
1490 @option{--interleave-width} option.
1492 This option is useful for creating files to program @sc{rom}. It is
1493 typically used with an @code{srec} output target. Note that
1494 @command{objcopy} will complain if you do not specify the
1495 @option{--byte} option as well.
1497 The default interleave breadth is 4, so with @option{--byte} set to 0,
1498 @command{objcopy} would copy the first byte out of every four bytes
1499 from the input to the output.
1501 @item --interleave-width=@var{width}
1502 When used with the @option{--interleave} option, copy @var{width}
1503 bytes at a time. The start of the range of bytes to be copied is set
1504 by the @option{--byte} option, and the extent of the range is set with
1505 the @option{--interleave} option.
1507 The default value for this option is 1. The value of @var{width} plus
1508 the @var{byte} value set by the @option{--byte} option must not exceed
1509 the interleave breadth set by the @option{--interleave} option.
1511 This option can be used to create images for two 16-bit flashes interleaved
1512 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1513 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1514 commands. If the input was '12345678' then the outputs would be
1515 '1256' and '3478' respectively.
1518 @itemx --preserve-dates
1519 Set the access and modification dates of the output file to be the same
1520 as those of the input file.
1523 @itemx --enable-deterministic-archives
1524 @cindex deterministic archives
1525 @kindex --enable-deterministic-archives
1526 Operate in @emph{deterministic} mode. When copying archive members
1527 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1528 and use consistent file modes for all files.
1530 If @file{binutils} was configured with
1531 @option{--enable-deterministic-archives}, then this mode is on by default.
1532 It can be disabled with the @samp{-U} option, below.
1535 @itemx --disable-deterministic-archives
1536 @cindex deterministic archives
1537 @kindex --enable-deterministic-archives
1538 Do @emph{not} operate in @emph{deterministic} mode. This is the
1539 inverse of the @option{-D} option, above: when copying archive members
1540 and writing the archive index, use their actual UID, GID, timestamp,
1541 and file mode values.
1543 This is the default unless @file{binutils} was configured with
1544 @option{--enable-deterministic-archives}.
1547 Convert debugging information, if possible. This is not the default
1548 because only certain debugging formats are supported, and the
1549 conversion process can be time consuming.
1551 @item --gap-fill @var{val}
1552 Fill gaps between sections with @var{val}. This operation applies to
1553 the @emph{load address} (LMA) of the sections. It is done by increasing
1554 the size of the section with the lower address, and filling in the extra
1555 space created with @var{val}.
1557 @item --pad-to @var{address}
1558 Pad the output file up to the load address @var{address}. This is
1559 done by increasing the size of the last section. The extra space is
1560 filled in with the value specified by @option{--gap-fill} (default zero).
1562 @item --set-start @var{val}
1563 Set the start address (also known as the entry address) of the new
1564 file to @var{val}. Not all object file formats support setting the
1567 @item --change-start @var{incr}
1568 @itemx --adjust-start @var{incr}
1569 @cindex changing start address
1570 Change the start address (also known as the entry address) by adding
1571 @var{incr}. Not all object file formats support setting the start
1574 @item --change-addresses @var{incr}
1575 @itemx --adjust-vma @var{incr}
1576 @cindex changing object addresses
1577 Change the VMA and LMA addresses of all sections, as well as the start
1578 address, by adding @var{incr}. Some object file formats do not permit
1579 section addresses to be changed arbitrarily. Note that this does not
1580 relocate the sections; if the program expects sections to be loaded at a
1581 certain address, and this option is used to change the sections such
1582 that they are loaded at a different address, the program may fail.
1584 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1585 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1586 @cindex changing section address
1587 Set or change both the VMA address and the LMA address of any section
1588 matching @var{sectionpattern}. If @samp{=} is used, the section
1589 address is set to @var{val}. Otherwise, @var{val} is added to or
1590 subtracted from the section address. See the comments under
1591 @option{--change-addresses}, above. If @var{sectionpattern} does not
1592 match any sections in the input file, a warning will be issued, unless
1593 @option{--no-change-warnings} is used.
1595 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1596 @cindex changing section LMA
1597 Set or change the LMA address of any sections matching
1598 @var{sectionpattern}. The LMA address is the address where the
1599 section will be loaded into memory at program load time. Normally
1600 this is the same as the VMA address, which is the address of the
1601 section at program run time, but on some systems, especially those
1602 where a program is held in ROM, the two can be different. If @samp{=}
1603 is used, the section address is set to @var{val}. Otherwise,
1604 @var{val} is added to or subtracted from the section address. See the
1605 comments under @option{--change-addresses}, above. If
1606 @var{sectionpattern} does not match any sections in the input file, a
1607 warning will be issued, unless @option{--no-change-warnings} is used.
1609 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1610 @cindex changing section VMA
1611 Set or change the VMA address of any section matching
1612 @var{sectionpattern}. The VMA address is the address where the
1613 section will be located once the program has started executing.
1614 Normally this is the same as the LMA address, which is the address
1615 where the section will be loaded into memory, but on some systems,
1616 especially those where a program is held in ROM, the two can be
1617 different. If @samp{=} is used, the section address is set to
1618 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1619 section address. See the comments under @option{--change-addresses},
1620 above. If @var{sectionpattern} does not match any sections in the
1621 input file, a warning will be issued, unless
1622 @option{--no-change-warnings} is used.
1624 @item --change-warnings
1625 @itemx --adjust-warnings
1626 If @option{--change-section-address} or @option{--change-section-lma} or
1627 @option{--change-section-vma} is used, and the section pattern does not
1628 match any sections, issue a warning. This is the default.
1630 @item --no-change-warnings
1631 @itemx --no-adjust-warnings
1632 Do not issue a warning if @option{--change-section-address} or
1633 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1634 if the section pattern does not match any sections.
1636 @item --set-section-flags @var{sectionpattern}=@var{flags}
1637 Set the flags for any sections matching @var{sectionpattern}. The
1638 @var{flags} argument is a comma separated string of flag names. The
1639 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1640 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1641 @samp{exclude}, @samp{share}, and @samp{debug}. You can set the
1642 @samp{contents} flag for a section which does not have contents, but it
1643 is not meaningful to clear the @samp{contents} flag of a section which
1644 does have contents--just remove the section instead. Not all flags are
1645 meaningful for all object file formats. In particular the
1646 @samp{share} flag is only meaningful for COFF format files and not for
1649 @item --set-section-alignment @var{sectionpattern}=@var{align}
1650 Set the alignment for any sections matching @var{sectionpattern}.
1651 @var{align} specifies the alignment in bytes and must be a power of
1652 two, i.e. 1, 2, 4, 8@dots{}.
1654 @item --add-section @var{sectionname}=@var{filename}
1655 Add a new section named @var{sectionname} while copying the file. The
1656 contents of the new section are taken from the file @var{filename}. The
1657 size of the section will be the size of the file. This option only
1658 works on file formats which can support sections with arbitrary names.
1659 Note - it may be necessary to use the @option{--set-section-flags}
1660 option to set the attributes of the newly created section.
1662 @item --dump-section @var{sectionname}=@var{filename}
1663 Place the contents of section named @var{sectionname} into the file
1664 @var{filename}, overwriting any contents that may have been there
1665 previously. This option is the inverse of @option{--add-section}.
1666 This option is similar to the @option{--only-section} option except
1667 that it does not create a formatted file, it just dumps the contents
1668 as raw binary data, without applying any relocations. The option can
1669 be specified more than once.
1671 @item --update-section @var{sectionname}=@var{filename}
1672 Replace the existing contents of a section named @var{sectionname}
1673 with the contents of file @var{filename}. The size of the section
1674 will be adjusted to the size of the file. The section flags for
1675 @var{sectionname} will be unchanged. For ELF format files the section
1676 to segment mapping will also remain unchanged, something which is not
1677 possible using @option{--remove-section} followed by
1678 @option{--add-section}. The option can be specified more than once.
1680 Note - it is possible to use @option{--rename-section} and
1681 @option{--update-section} to both update and rename a section from one
1682 command line. In this case, pass the original section name to
1683 @option{--update-section}, and the original and new section names to
1684 @option{--rename-section}.
1686 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1687 Add a new symbol named @var{name} while copying the file. This option may be
1688 specified multiple times. If the @var{section} is given, the symbol will be
1689 associated with and relative to that section, otherwise it will be an ABS
1690 symbol. Specifying an undefined section will result in a fatal error. There
1691 is no check for the value, it will be taken as specified. Symbol flags can
1692 be specified and not all flags will be meaningful for all object file
1693 formats. By default, the symbol will be global. The special flag
1694 'before=@var{othersym}' will insert the new symbol in front of the specified
1695 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1696 symbol table in the order they appear.
1698 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1699 Rename a section from @var{oldname} to @var{newname}, optionally
1700 changing the section's flags to @var{flags} in the process. This has
1701 the advantage over using a linker script to perform the rename in that
1702 the output stays as an object file and does not become a linked
1703 executable. This option accepts the same set of flags as the
1704 @option{--sect-section-flags} option.
1706 This option is particularly helpful when the input format is binary,
1707 since this will always create a section called .data. If for example,
1708 you wanted instead to create a section called .rodata containing binary
1709 data you could use the following command line to achieve it:
1712 objcopy -I binary -O <output_format> -B <architecture> \
1713 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1714 <input_binary_file> <output_object_file>
1717 @item --long-section-names @{enable,disable,keep@}
1718 Controls the handling of long section names when processing @code{COFF}
1719 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1720 is to preserve long section names if any are present in the input file.
1721 The @samp{enable} and @samp{disable} options forcibly enable or disable
1722 the use of long section names in the output object; when @samp{disable}
1723 is in effect, any long section names in the input object will be truncated.
1724 The @samp{enable} option will only emit long section names if any are
1725 present in the inputs; this is mostly the same as @samp{keep}, but it
1726 is left undefined whether the @samp{enable} option might force the
1727 creation of an empty string table in the output file.
1729 @item --change-leading-char
1730 Some object file formats use special characters at the start of
1731 symbols. The most common such character is underscore, which compilers
1732 often add before every symbol. This option tells @command{objcopy} to
1733 change the leading character of every symbol when it converts between
1734 object file formats. If the object file formats use the same leading
1735 character, this option has no effect. Otherwise, it will add a
1736 character, or remove a character, or change a character, as
1739 @item --remove-leading-char
1740 If the first character of a global symbol is a special symbol leading
1741 character used by the object file format, remove the character. The
1742 most common symbol leading character is underscore. This option will
1743 remove a leading underscore from all global symbols. This can be useful
1744 if you want to link together objects of different file formats with
1745 different conventions for symbol names. This is different from
1746 @option{--change-leading-char} because it always changes the symbol name
1747 when appropriate, regardless of the object file format of the output
1750 @item --reverse-bytes=@var{num}
1751 Reverse the bytes in a section with output contents. A section length must
1752 be evenly divisible by the value given in order for the swap to be able to
1753 take place. Reversing takes place before the interleaving is performed.
1755 This option is used typically in generating ROM images for problematic
1756 target systems. For example, on some target boards, the 32-bit words
1757 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1758 regardless of the CPU byte order. Depending on the programming model, the
1759 endianness of the ROM may need to be modified.
1761 Consider a simple file with a section containing the following eight
1762 bytes: @code{12345678}.
1764 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1765 output file would be ordered @code{21436587}.
1767 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1768 output file would be ordered @code{43218765}.
1770 By using @samp{--reverse-bytes=2} for the above example, followed by
1771 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1772 output file would be ordered @code{34127856}.
1774 @item --srec-len=@var{ival}
1775 Meaningful only for srec output. Set the maximum length of the Srecords
1776 being produced to @var{ival}. This length covers both address, data and
1779 @item --srec-forceS3
1780 Meaningful only for srec output. Avoid generation of S1/S2 records,
1781 creating S3-only record format.
1783 @item --redefine-sym @var{old}=@var{new}
1784 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1785 when one is trying link two things together for which you have no
1786 source, and there are name collisions.
1788 @item --redefine-syms=@var{filename}
1789 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1790 listed in the file @var{filename}. @var{filename} is simply a flat file,
1791 with one symbol pair per line. Line comments may be introduced by the hash
1792 character. This option may be given more than once.
1795 Change all global symbols in the file to be weak. This can be useful
1796 when building an object which will be linked against other objects using
1797 the @option{-R} option to the linker. This option is only effective when
1798 using an object file format which supports weak symbols.
1800 @item --keep-symbols=@var{filename}
1801 Apply @option{--keep-symbol} option to each symbol listed in the file
1802 @var{filename}. @var{filename} is simply a flat file, with one symbol
1803 name per line. Line comments may be introduced by the hash character.
1804 This option may be given more than once.
1806 @item --strip-symbols=@var{filename}
1807 Apply @option{--strip-symbol} option to each symbol listed in the file
1808 @var{filename}. @var{filename} is simply a flat file, with one symbol
1809 name per line. Line comments may be introduced by the hash character.
1810 This option may be given more than once.
1812 @item --strip-unneeded-symbols=@var{filename}
1813 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1814 the file @var{filename}. @var{filename} is simply a flat file, with one
1815 symbol name per line. Line comments may be introduced by the hash
1816 character. This option may be given more than once.
1818 @item --keep-global-symbols=@var{filename}
1819 Apply @option{--keep-global-symbol} option to each symbol listed in the
1820 file @var{filename}. @var{filename} is simply a flat file, with one
1821 symbol name per line. Line comments may be introduced by the hash
1822 character. This option may be given more than once.
1824 @item --localize-symbols=@var{filename}
1825 Apply @option{--localize-symbol} option to each symbol listed in the file
1826 @var{filename}. @var{filename} is simply a flat file, with one symbol
1827 name per line. Line comments may be introduced by the hash character.
1828 This option may be given more than once.
1830 @item --globalize-symbols=@var{filename}
1831 Apply @option{--globalize-symbol} option to each symbol listed in the file
1832 @var{filename}. @var{filename} is simply a flat file, with one symbol
1833 name per line. Line comments may be introduced by the hash character.
1834 This option may be given more than once. Note: this option cannot be
1835 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1838 @item --weaken-symbols=@var{filename}
1839 Apply @option{--weaken-symbol} option to each symbol listed in the file
1840 @var{filename}. @var{filename} is simply a flat file, with one symbol
1841 name per line. Line comments may be introduced by the hash character.
1842 This option may be given more than once.
1844 @item --alt-machine-code=@var{index}
1845 If the output architecture has alternate machine codes, use the
1846 @var{index}th code instead of the default one. This is useful in case
1847 a machine is assigned an official code and the tool-chain adopts the
1848 new code, but other applications still depend on the original code
1849 being used. For ELF based architectures if the @var{index}
1850 alternative does not exist then the value is treated as an absolute
1851 number to be stored in the e_machine field of the ELF header.
1853 @item --writable-text
1854 Mark the output text as writable. This option isn't meaningful for all
1855 object file formats.
1857 @item --readonly-text
1858 Make the output text write protected. This option isn't meaningful for all
1859 object file formats.
1862 Mark the output file as demand paged. This option isn't meaningful for all
1863 object file formats.
1866 Mark the output file as impure. This option isn't meaningful for all
1867 object file formats.
1869 @item --prefix-symbols=@var{string}
1870 Prefix all symbols in the output file with @var{string}.
1872 @item --prefix-sections=@var{string}
1873 Prefix all section names in the output file with @var{string}.
1875 @item --prefix-alloc-sections=@var{string}
1876 Prefix all the names of all allocated sections in the output file with
1879 @item --add-gnu-debuglink=@var{path-to-file}
1880 Creates a .gnu_debuglink section which contains a reference to
1881 @var{path-to-file} and adds it to the output file. Note: the file at
1882 @var{path-to-file} must exist. Part of the process of adding the
1883 .gnu_debuglink section involves embedding a checksum of the contents
1884 of the debug info file into the section.
1886 If the debug info file is built in one location but it is going to be
1887 installed at a later time into a different location then do not use
1888 the path to the installed location. The @option{--add-gnu-debuglink}
1889 option will fail because the installed file does not exist yet.
1890 Instead put the debug info file in the current directory and use the
1891 @option{--add-gnu-debuglink} option without any directory components,
1895 objcopy --add-gnu-debuglink=foo.debug
1898 At debug time the debugger will attempt to look for the separate debug
1899 info file in a set of known locations. The exact set of these
1900 locations varies depending upon the distribution being used, but it
1905 @item * The same directory as the executable.
1907 @item * A sub-directory of the directory containing the executable
1910 @item * A global debug directory such as /usr/lib/debug.
1913 As long as the debug info file has been installed into one of these
1914 locations before the debugger is run everything should work
1917 @item --keep-file-symbols
1918 When stripping a file, perhaps with @option{--strip-debug} or
1919 @option{--strip-unneeded}, retain any symbols specifying source file names,
1920 which would otherwise get stripped.
1922 @item --only-keep-debug
1923 Strip a file, removing contents of any sections that would not be
1924 stripped by @option{--strip-debug} and leaving the debugging sections
1925 intact. In ELF files, this preserves all note sections in the output.
1927 Note - the section headers of the stripped sections are preserved,
1928 including their sizes, but the contents of the section are discarded.
1929 The section headers are preserved so that other tools can match up the
1930 debuginfo file with the real executable, even if that executable has
1931 been relocated to a different address space.
1933 The intention is that this option will be used in conjunction with
1934 @option{--add-gnu-debuglink} to create a two part executable. One a
1935 stripped binary which will occupy less space in RAM and in a
1936 distribution and the second a debugging information file which is only
1937 needed if debugging abilities are required. The suggested procedure
1938 to create these files is as follows:
1941 @item Link the executable as normal. Assuming that it is called
1943 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1944 create a file containing the debugging info.
1945 @item Run @code{objcopy --strip-debug foo} to create a
1946 stripped executable.
1947 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1948 to add a link to the debugging info into the stripped executable.
1951 Note---the choice of @code{.dbg} as an extension for the debug info
1952 file is arbitrary. Also the @code{--only-keep-debug} step is
1953 optional. You could instead do this:
1956 @item Link the executable as normal.
1957 @item Copy @code{foo} to @code{foo.full}
1958 @item Run @code{objcopy --strip-debug foo}
1959 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1962 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1963 full executable. It does not have to be a file created by the
1964 @option{--only-keep-debug} switch.
1966 Note---this switch is only intended for use on fully linked files. It
1967 does not make sense to use it on object files where the debugging
1968 information may be incomplete. Besides the gnu_debuglink feature
1969 currently only supports the presence of one filename containing
1970 debugging information, not multiple filenames on a one-per-object-file
1974 Remove the contents of all DWARF .dwo sections, leaving the
1975 remaining debugging sections and all symbols intact.
1976 This option is intended for use by the compiler as part of
1977 the @option{-gsplit-dwarf} option, which splits debug information
1978 between the .o file and a separate .dwo file. The compiler
1979 generates all debug information in the same file, then uses
1980 the @option{--extract-dwo} option to copy the .dwo sections to
1981 the .dwo file, then the @option{--strip-dwo} option to remove
1982 those sections from the original .o file.
1985 Extract the contents of all DWARF .dwo sections. See the
1986 @option{--strip-dwo} option for more information.
1988 @item --file-alignment @var{num}
1989 Specify the file alignment. Sections in the file will always begin at
1990 file offsets which are multiples of this number. This defaults to
1992 [This option is specific to PE targets.]
1994 @item --heap @var{reserve}
1995 @itemx --heap @var{reserve},@var{commit}
1996 Specify the number of bytes of memory to reserve (and optionally commit)
1997 to be used as heap for this program.
1998 [This option is specific to PE targets.]
2000 @item --image-base @var{value}
2001 Use @var{value} as the base address of your program or dll. This is
2002 the lowest memory location that will be used when your program or dll
2003 is loaded. To reduce the need to relocate and improve performance of
2004 your dlls, each should have a unique base address and not overlap any
2005 other dlls. The default is 0x400000 for executables, and 0x10000000
2007 [This option is specific to PE targets.]
2009 @item --section-alignment @var{num}
2010 Sets the section alignment field in the PE header. Sections in memory
2011 will always begin at addresses which are a multiple of this number.
2013 [This option is specific to PE targets.]
2015 @item --stack @var{reserve}
2016 @itemx --stack @var{reserve},@var{commit}
2017 Specify the number of bytes of memory to reserve (and optionally commit)
2018 to be used as stack for this program.
2019 [This option is specific to PE targets.]
2021 @item --subsystem @var{which}
2022 @itemx --subsystem @var{which}:@var{major}
2023 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2024 Specifies the subsystem under which your program will execute. The
2025 legal values for @var{which} are @code{native}, @code{windows},
2026 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
2027 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
2028 the subsystem version also. Numeric values are also accepted for
2030 [This option is specific to PE targets.]
2032 @item --extract-symbol
2033 Keep the file's section flags and symbols but remove all section data.
2034 Specifically, the option:
2037 @item removes the contents of all sections;
2038 @item sets the size of every section to zero; and
2039 @item sets the file's start address to zero.
2042 This option is used to build a @file{.sym} file for a VxWorks kernel.
2043 It can also be a useful way of reducing the size of a @option{--just-symbols}
2046 @item --compress-debug-sections
2047 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2048 ELF ABI. Note - if compression would actually make a section
2049 @emph{larger}, then it is not compressed.
2051 @item --compress-debug-sections=none
2052 @itemx --compress-debug-sections=zlib
2053 @itemx --compress-debug-sections=zlib-gnu
2054 @itemx --compress-debug-sections=zlib-gabi
2055 For ELF files, these options control how DWARF debug sections are
2056 compressed. @option{--compress-debug-sections=none} is equivalent
2057 to @option{--decompress-debug-sections}.
2058 @option{--compress-debug-sections=zlib} and
2059 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2060 @option{--compress-debug-sections}.
2061 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
2062 sections using zlib. The debug sections are renamed to begin with
2063 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
2064 actually make a section @emph{larger}, then it is not compressed nor
2067 @item --decompress-debug-sections
2068 Decompress DWARF debug sections using zlib. The original section
2069 names of the compressed sections are restored.
2071 @item --elf-stt-common=yes
2072 @itemx --elf-stt-common=no
2073 For ELF files, these options control whether common symbols should be
2074 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2075 @option{--elf-stt-common=yes} converts common symbol type to
2076 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2077 type to @code{STT_OBJECT}.
2080 @itemx --no-merge-notes
2081 For ELF files, attempt (or do not attempt) to reduce the size of any
2082 SHT_NOTE type sections by removing duplicate notes.
2086 Show the version number of @command{objcopy}.
2088 @item --verilog-data-width=@var{bytes}
2089 For Verilog output, this options controls the number of bytes
2090 converted for each output data element. The input target controls the
2091 endianness of the conversion.
2095 Verbose output: list all object files modified. In the case of
2096 archives, @samp{objcopy -V} lists all members of the archive.
2099 Show a summary of the options to @command{objcopy}.
2102 Display a list showing all architectures and object formats available.
2108 @c man begin SEEALSO objcopy
2109 ld(1), objdump(1), and the Info entries for @file{binutils}.
2116 @cindex object file information
2119 @c man title objdump display information from object files
2122 @c man begin SYNOPSIS objdump
2123 objdump [@option{-a}|@option{--archive-headers}]
2124 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2125 [@option{-C}|@option{--demangle}[=@var{style}] ]
2126 [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2127 [@option{-D}|@option{--disassemble-all}]
2128 [@option{-z}|@option{--disassemble-zeroes}]
2129 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2130 [@option{-f}|@option{--file-headers}]
2131 [@option{-F}|@option{--file-offsets}]
2132 [@option{--file-start-context}]
2133 [@option{-g}|@option{--debugging}]
2134 [@option{-e}|@option{--debugging-tags}]
2135 [@option{-h}|@option{--section-headers}|@option{--headers}]
2136 [@option{-i}|@option{--info}]
2137 [@option{-j} @var{section}|@option{--section=}@var{section}]
2138 [@option{-l}|@option{--line-numbers}]
2139 [@option{-S}|@option{--source}]
2140 [@option{--source-comment}[=@var{text}]]
2141 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2142 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2143 [@option{-p}|@option{--private-headers}]
2144 [@option{-P} @var{options}|@option{--private=}@var{options}]
2145 [@option{-r}|@option{--reloc}]
2146 [@option{-R}|@option{--dynamic-reloc}]
2147 [@option{-s}|@option{--full-contents}]
2148 [@option{-W[lLiaprmfFsoORtUuTgAckK]}|
2149 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
2150 [@option{--ctf=}@var{section}]
2151 [@option{-G}|@option{--stabs}]
2152 [@option{-t}|@option{--syms}]
2153 [@option{-T}|@option{--dynamic-syms}]
2154 [@option{-x}|@option{--all-headers}]
2155 [@option{-w}|@option{--wide}]
2156 [@option{--start-address=}@var{address}]
2157 [@option{--stop-address=}@var{address}]
2158 [@option{--no-addresses}]
2159 [@option{--prefix-addresses}]
2160 [@option{--[no-]show-raw-insn}]
2161 [@option{--adjust-vma=}@var{offset}]
2162 [@option{--dwarf-depth=@var{n}}]
2163 [@option{--dwarf-start=@var{n}}]
2164 [@option{--ctf-parent=}@var{section}]
2165 [@option{--no-recurse-limit}|@option{--recurse-limit}]
2166 [@option{--special-syms}]
2167 [@option{--prefix=}@var{prefix}]
2168 [@option{--prefix-strip=}@var{level}]
2169 [@option{--insn-width=}@var{width}]
2170 [@option{--visualize-jumps[=color|=extended-color|=off]}
2171 [@option{-V}|@option{--version}]
2172 [@option{-H}|@option{--help}]
2173 @var{objfile}@dots{}
2177 @c man begin DESCRIPTION objdump
2179 @command{objdump} displays information about one or more object files.
2180 The options control what particular information to display. This
2181 information is mostly useful to programmers who are working on the
2182 compilation tools, as opposed to programmers who just want their
2183 program to compile and work.
2185 @var{objfile}@dots{} are the object files to be examined. When you
2186 specify archives, @command{objdump} shows information on each of the member
2191 @c man begin OPTIONS objdump
2193 The long and short forms of options, shown here as alternatives, are
2194 equivalent. At least one option from the list
2195 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2199 @itemx --archive-header
2200 @cindex archive headers
2201 If any of the @var{objfile} files are archives, display the archive
2202 header information (in a format similar to @samp{ls -l}). Besides the
2203 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2204 the object file format of each archive member.
2206 @item --adjust-vma=@var{offset}
2207 @cindex section addresses in objdump
2208 @cindex VMA in objdump
2209 When dumping information, first add @var{offset} to all the section
2210 addresses. This is useful if the section addresses do not correspond to
2211 the symbol table, which can happen when putting sections at particular
2212 addresses when using a format which can not represent section addresses,
2215 @item -b @var{bfdname}
2216 @itemx --target=@var{bfdname}
2217 @cindex object code format
2218 Specify that the object-code format for the object files is
2219 @var{bfdname}. This option may not be necessary; @var{objdump} can
2220 automatically recognize many formats.
2224 objdump -b oasys -m vax -h fu.o
2227 displays summary information from the section headers (@option{-h}) of
2228 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2229 file in the format produced by Oasys compilers. You can list the
2230 formats available with the @option{-i} option.
2231 @xref{Target Selection}, for more information.
2234 @itemx --demangle[=@var{style}]
2235 @cindex demangling in objdump
2236 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2237 Besides removing any initial underscore prepended by the system, this
2238 makes C++ function names readable. Different compilers have different
2239 mangling styles. The optional demangling style argument can be used to
2240 choose an appropriate demangling style for your compiler. @xref{c++filt},
2241 for more information on demangling.
2243 @item --recurse-limit
2244 @itemx --no-recurse-limit
2245 @itemx --recursion-limit
2246 @itemx --no-recursion-limit
2247 Enables or disables a limit on the amount of recursion performed
2248 whilst demangling strings. Since the name mangling formats allow for
2249 an inifinite level of recursion it is possible to create strings whose
2250 decoding will exhaust the amount of stack space available on the host
2251 machine, triggering a memory fault. The limit tries to prevent this
2252 from happening by restricting recursion to 2048 levels of nesting.
2254 The default is for this limit to be enabled, but disabling it may be
2255 necessary in order to demangle truly complicated names. Note however
2256 that if the recursion limit is disabled then stack exhaustion is
2257 possible and any bug reports about such an event will be rejected.
2261 Display debugging information. This attempts to parse STABS
2262 debugging format information stored in the file and print it out using
2263 a C like syntax. If no STABS debugging was found this option
2264 falls back on the @option{-W} option to print any DWARF information in
2268 @itemx --debugging-tags
2269 Like @option{-g}, but the information is generated in a format compatible
2273 @itemx --disassemble
2274 @itemx --disassemble=@var{symbol}
2275 @cindex disassembling object code
2276 @cindex machine instructions
2277 Display the assembler mnemonics for the machine instructions from the
2278 input file. This option only disassembles those sections which are
2279 expected to contain instructions. If the optional @var{symbol}
2280 argument is given, then display the assembler mnemonics starting at
2281 @var{symbol}. If @var{symbol} is a function name then disassembly
2282 will stop at the end of the function, otherwise it will stop when the
2283 next symbol is encountered. If there are no matches for @var{symbol}
2284 then nothing will be displayed.
2286 Note if the @option{--dwarf=follow-links} option has also been enabled
2287 then any symbol tables in linked debug info files will be read in and
2288 used when disassembling.
2291 @itemx --disassemble-all
2292 Like @option{-d}, but disassemble the contents of all sections, not just
2293 those expected to contain instructions.
2295 This option also has a subtle effect on the disassembly of
2296 instructions in code sections. When option @option{-d} is in effect
2297 objdump will assume that any symbols present in a code section occur
2298 on the boundary between instructions and it will refuse to disassemble
2299 across such a boundary. When option @option{-D} is in effect however
2300 this assumption is supressed. This means that it is possible for the
2301 output of @option{-d} and @option{-D} to differ if, for example, data
2302 is stored in code sections.
2304 If the target is an ARM architecture this switch also has the effect
2305 of forcing the disassembler to decode pieces of data found in code
2306 sections as if they were instructions.
2308 Note if the @option{--dwarf=follow-links} option has also been enabled
2309 then any symbol tables in linked debug info files will be read in and
2310 used when disassembling.
2312 @item --no-addresses
2313 When disassembling, don't print addresses on each line or for symbols
2314 and relocation offsets. In combination with @option{--no-show-raw-insn}
2315 this may be useful for comparing compiler output.
2317 @item --prefix-addresses
2318 When disassembling, print the complete address on each line. This is
2319 the older disassembly format.
2323 @itemx --endian=@{big|little@}
2325 @cindex disassembly endianness
2326 Specify the endianness of the object files. This only affects
2327 disassembly. This can be useful when disassembling a file format which
2328 does not describe endianness information, such as S-records.
2331 @itemx --file-headers
2332 @cindex object file header
2333 Display summary information from the overall header of
2334 each of the @var{objfile} files.
2337 @itemx --file-offsets
2338 @cindex object file offsets
2339 When disassembling sections, whenever a symbol is displayed, also
2340 display the file offset of the region of data that is about to be
2341 dumped. If zeroes are being skipped, then when disassembly resumes,
2342 tell the user how many zeroes were skipped and the file offset of the
2343 location from where the disassembly resumes. When dumping sections,
2344 display the file offset of the location from where the dump starts.
2346 @item --file-start-context
2347 @cindex source code context
2348 Specify that when displaying interlisted source code/disassembly
2349 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2350 context to the start of the file.
2353 @itemx --section-headers
2355 @cindex section headers
2356 Display summary information from the section headers of the
2359 File segments may be relocated to nonstandard addresses, for example by
2360 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2361 @command{ld}. However, some object file formats, such as a.out, do not
2362 store the starting address of the file segments. In those situations,
2363 although @command{ld} relocates the sections correctly, using @samp{objdump
2364 -h} to list the file section headers cannot show the correct addresses.
2365 Instead, it shows the usual addresses, which are implicit for the
2368 Note, in some cases it is possible for a section to have both the
2369 READONLY and the NOREAD attributes set. In such cases the NOREAD
2370 attribute takes precedence, but @command{objdump} will report both
2371 since the exact setting of the flag bits might be important.
2375 Print a summary of the options to @command{objdump} and exit.
2379 @cindex architectures available
2380 @cindex object formats available
2381 Display a list showing all architectures and object formats available
2382 for specification with @option{-b} or @option{-m}.
2385 @itemx --section=@var{name}
2386 @cindex section information
2387 Display information only for section @var{name}.
2390 @itemx --line-numbers
2391 @cindex source filenames for object files
2392 Label the display (using debugging information) with the filename and
2393 source line numbers corresponding to the object code or relocs shown.
2394 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2396 @item -m @var{machine}
2397 @itemx --architecture=@var{machine}
2398 @cindex architecture
2399 @cindex disassembly architecture
2400 Specify the architecture to use when disassembling object files. This
2401 can be useful when disassembling object files which do not describe
2402 architecture information, such as S-records. You can list the available
2403 architectures with the @option{-i} option.
2405 If the target is an ARM architecture then this switch has an
2406 additional effect. It restricts the disassembly to only those
2407 instructions supported by the architecture specified by @var{machine}.
2408 If it is necessary to use this switch because the input file does not
2409 contain any architecture information, but it is also desired to
2410 disassemble all the instructions use @option{-marm}.
2412 @item -M @var{options}
2413 @itemx --disassembler-options=@var{options}
2414 Pass target specific information to the disassembler. Only supported on
2415 some targets. If it is necessary to specify more than one
2416 disassembler option then multiple @option{-M} options can be used or
2417 can be placed together into a comma separated list.
2419 For ARC, @option{dsp} controls the printing of DSP instructions,
2420 @option{spfp} selects the printing of FPX single precision FP
2421 instructions, @option{dpfp} selects the printing of FPX double
2422 precision FP instructions, @option{quarkse_em} selects the printing of
2423 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2424 of double precision assist instructions, @option{fpus} selects the
2425 printing of FPU single precision FP instructions, while @option{fpud}
2426 selects the printing of FPU double precision FP instructions.
2427 Additionally, one can choose to have all the immediates printed in
2428 hexadecimal using @option{hex}. By default, the short immediates are
2429 printed using the decimal representation, while the long immediate
2430 values are printed as hexadecimal.
2432 @option{cpu=...} allows to enforce a particular ISA when disassembling
2433 instructions, overriding the @option{-m} value or whatever is in the ELF file.
2434 This might be useful to select ARC EM or HS ISA, because architecture is same
2435 for those and disassembler relies on private ELF header data to decide if code
2436 is for EM or HS. This option might be specified multiple times - only the
2437 latest value will be used. Valid values are same as for the assembler
2438 @option{-mcpu=...} option.
2440 If the target is an ARM architecture then this switch can be used to
2441 select which register name set is used during disassembler. Specifying
2442 @option{-M reg-names-std} (the default) will select the register names as
2443 used in ARM's instruction set documentation, but with register 13 called
2444 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2445 @option{-M reg-names-apcs} will select the name set used by the ARM
2446 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2447 just use @samp{r} followed by the register number.
2449 There are also two variants on the APCS register naming scheme enabled
2450 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2451 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2452 with the normal register names or the special register names).
2454 This option can also be used for ARM architectures to force the
2455 disassembler to interpret all instructions as Thumb instructions by
2456 using the switch @option{--disassembler-options=force-thumb}. This can be
2457 useful when attempting to disassemble thumb code produced by other
2460 For AArch64 targets this switch can be used to set whether instructions are
2461 disassembled as the most general instruction using the @option{-M no-aliases}
2462 option or whether instruction notes should be generated as comments in the
2463 disasssembly using @option{-M notes}.
2465 For the x86, some of the options duplicate functions of the @option{-m}
2466 switch, but allow finer grained control.
2471 Select disassembly for the given architecture.
2475 Select between intel syntax mode and AT&T syntax mode.
2479 Select between AMD64 ISA and Intel64 ISA.
2481 @item intel-mnemonic
2483 Select between intel mnemonic mode and AT&T mnemonic mode.
2484 Note: @code{intel-mnemonic} implies @code{intel} and
2485 @code{att-mnemonic} implies @code{att}.
2492 Specify the default address size and operand size. These five options
2493 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2494 appear later in the option string.
2497 When in AT&T mode and also for a limited set of instructions when in Intel
2498 mode, instructs the disassembler to print a mnemonic suffix even when the
2499 suffix could be inferred by the operands or, for certain instructions, the
2500 execution mode's defaults.
2503 For PowerPC, the @option{-M} argument @option{raw} selects
2504 disasssembly of hardware insns rather than aliases. For example, you
2505 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2506 rather than @code{li}. All of the @option{-m} arguments for
2507 @command{gas} that select a CPU are supported. These are:
2508 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2509 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2510 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2511 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2512 @option{booke32}, @option{cell}, @option{com}, @option{e200z4},
2513 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2514 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2515 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2516 @option{power8}, @option{power9}, @option{power10}, @option{ppc},
2517 @option{ppc32}, @option{ppc64}, @option{ppc64bridge}, @option{ppcps},
2518 @option{pwr}, @option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2519 @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9}, @option{pwr10},
2520 @option{pwrx}, @option{titan}, and @option{vle}.
2521 @option{32} and @option{64} modify the default or a prior CPU
2522 selection, disabling and enabling 64-bit insns respectively. In
2523 addition, @option{altivec}, @option{any}, @option{htm}, @option{vsx},
2524 and @option{spe} add capabilities to a previous @emph{or later} CPU
2525 selection. @option{any} will disassemble any opcode known to
2526 binutils, but in cases where an opcode has two different meanings or
2527 different arguments, you may not see the disassembly you expect.
2528 If you disassemble without giving a CPU selection, a default will be
2529 chosen from information gleaned by BFD from the object files headers,
2530 but the result again may not be as you expect.
2532 For MIPS, this option controls the printing of instruction mnemonic
2533 names and register names in disassembled instructions. Multiple
2534 selections from the following may be specified as a comma separated
2535 string, and invalid options are ignored:
2539 Print the 'raw' instruction mnemonic instead of some pseudo
2540 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2541 'sll' instead of 'nop', etc.
2544 Disassemble MSA instructions.
2547 Disassemble the virtualization ASE instructions.
2550 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2552 @item gpr-names=@var{ABI}
2553 Print GPR (general-purpose register) names as appropriate
2554 for the specified ABI. By default, GPR names are selected according to
2555 the ABI of the binary being disassembled.
2557 @item fpr-names=@var{ABI}
2558 Print FPR (floating-point register) names as
2559 appropriate for the specified ABI. By default, FPR numbers are printed
2562 @item cp0-names=@var{ARCH}
2563 Print CP0 (system control coprocessor; coprocessor 0) register names
2564 as appropriate for the CPU or architecture specified by
2565 @var{ARCH}. By default, CP0 register names are selected according to
2566 the architecture and CPU of the binary being disassembled.
2568 @item hwr-names=@var{ARCH}
2569 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2570 as appropriate for the CPU or architecture specified by
2571 @var{ARCH}. By default, HWR names are selected according to
2572 the architecture and CPU of the binary being disassembled.
2574 @item reg-names=@var{ABI}
2575 Print GPR and FPR names as appropriate for the selected ABI.
2577 @item reg-names=@var{ARCH}
2578 Print CPU-specific register names (CP0 register and HWR names)
2579 as appropriate for the selected CPU or architecture.
2582 For any of the options listed above, @var{ABI} or
2583 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2584 rather than names, for the selected types of registers.
2585 You can list the available values of @var{ABI} and @var{ARCH} using
2586 the @option{--help} option.
2588 For VAX, you can specify function entry addresses with @option{-M
2589 entry:0xf00ba}. You can use this multiple times to properly
2590 disassemble VAX binary files that don't contain symbol tables (like
2591 ROM dumps). In these cases, the function entry mask would otherwise
2592 be decoded as VAX instructions, which would probably lead the rest
2593 of the function being wrongly disassembled.
2596 @itemx --private-headers
2597 Print information that is specific to the object file format. The exact
2598 information printed depends upon the object file format. For some
2599 object file formats, no additional information is printed.
2601 @item -P @var{options}
2602 @itemx --private=@var{options}
2603 Print information that is specific to the object file format. The
2604 argument @var{options} is a comma separated list that depends on the
2605 format (the lists of options is displayed with the help).
2607 For XCOFF, the available options are:
2623 Not all object formats support this option. In particular the ELF
2624 format does not use it.
2628 @cindex relocation entries, in object file
2629 Print the relocation entries of the file. If used with @option{-d} or
2630 @option{-D}, the relocations are printed interspersed with the
2634 @itemx --dynamic-reloc
2635 @cindex dynamic relocation entries, in object file
2636 Print the dynamic relocation entries of the file. This is only
2637 meaningful for dynamic objects, such as certain types of shared
2638 libraries. As for @option{-r}, if used with @option{-d} or
2639 @option{-D}, the relocations are printed interspersed with the
2643 @itemx --full-contents
2644 @cindex sections, full contents
2645 @cindex object file sections
2646 Display the full contents of any sections requested. By default all
2647 non-empty sections are displayed.
2651 @cindex source disassembly
2652 @cindex disassembly, with source
2653 Display source code intermixed with disassembly, if possible. Implies
2656 @item --source-comment[=@var{txt}]
2657 @cindex source disassembly
2658 @cindex disassembly, with source
2659 Like the @option{-S} option, but all source code lines are displayed
2660 with a prefix of @var{txt}. Typically @var{txt} will be a comment
2661 string which can be used to distinguish the assembler code from the
2662 source code. If @var{txt} is not provided then a default string of
2663 @var{``# ``} (hash followed by a space), will be used.
2665 @item --prefix=@var{prefix}
2666 @cindex Add prefix to absolute paths
2667 Specify @var{prefix} to add to the absolute paths when used with
2670 @item --prefix-strip=@var{level}
2671 @cindex Strip absolute paths
2672 Indicate how many initial directory names to strip off the hardwired
2673 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2675 @item --show-raw-insn
2676 When disassembling instructions, print the instruction in hex as well as
2677 in symbolic form. This is the default except when
2678 @option{--prefix-addresses} is used.
2680 @item --no-show-raw-insn
2681 When disassembling instructions, do not print the instruction bytes.
2682 This is the default when @option{--prefix-addresses} is used.
2684 @item --insn-width=@var{width}
2685 @cindex Instruction width
2686 Display @var{width} bytes on a single line when disassembling
2689 @item --visualize-jumps[=color|=extended-color|=off]
2690 Visualize jumps that stay inside a function by drawing ASCII art between
2691 the start and target addresses. The optional @option{=color} argument
2692 adds color to the output using simple terminal colors. Alternatively
2693 the @option{=extended-color} argument will add color using 8bit
2694 colors, but these might not work on all terminals.
2696 If it is necessary to disable the @option{visualize-jumps} option
2697 after it has previously been enabled then use
2698 @option{visualize-jumps=off}.
2700 @item -W[lLiaprmfFsoORtUuTgAckK]
2701 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2702 @include debug.options.texi
2705 Enable additional checks for consistency of Dwarf information.
2707 @include ctf.options.texi
2713 @cindex debug symbols
2714 @cindex ELF object file format
2715 Display the full contents of any sections requested. Display the
2716 contents of the .stab and .stab.index and .stab.excl sections from an
2717 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2718 @code{.stab} debugging symbol-table entries are carried in an ELF
2719 section. In most other file formats, debugging symbol-table entries are
2720 interleaved with linkage symbols, and are visible in the @option{--syms}
2723 @item --start-address=@var{address}
2724 @cindex start-address
2725 Start displaying data at the specified address. This affects the output
2726 of the @option{-d}, @option{-r} and @option{-s} options.
2728 @item --stop-address=@var{address}
2729 @cindex stop-address
2730 Stop displaying data at the specified address. This affects the output
2731 of the @option{-d}, @option{-r} and @option{-s} options.
2735 @cindex symbol table entries, printing
2736 Print the symbol table entries of the file.
2737 This is similar to the information provided by the @samp{nm} program,
2738 although the display format is different. The format of the output
2739 depends upon the format of the file being dumped, but there are two main
2740 types. One looks like this:
2743 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2744 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2747 where the number inside the square brackets is the number of the entry
2748 in the symbol table, the @var{sec} number is the section number, the
2749 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2750 symbol's type, the @var{scl} number is the symbol's storage class and
2751 the @var{nx} value is the number of auxilary entries associated with
2752 the symbol. The last two fields are the symbol's value and its name.
2754 The other common output format, usually seen with ELF based files,
2758 00000000 l d .bss 00000000 .bss
2759 00000000 g .text 00000000 fred
2762 Here the first number is the symbol's value (sometimes refered to as
2763 its address). The next field is actually a set of characters and
2764 spaces indicating the flag bits that are set on the symbol. These
2765 characters are described below. Next is the section with which the
2766 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2767 not connected with any section), or @emph{*UND*} if the section is
2768 referenced in the file being dumped, but not defined there.
2770 After the section name comes another field, a number, which for common
2771 symbols is the alignment and for other symbol is the size. Finally
2772 the symbol's name is displayed.
2774 The flag characters are divided into 7 groups as follows:
2780 The symbol is a local (l), global (g), unique global (u), neither
2781 global nor local (a space) or both global and local (!). A
2782 symbol can be neither local or global for a variety of reasons, e.g.,
2783 because it is used for debugging, but it is probably an indication of
2784 a bug if it is ever both local and global. Unique global symbols are
2785 a GNU extension to the standard set of ELF symbol bindings. For such
2786 a symbol the dynamic linker will make sure that in the entire process
2787 there is just one symbol with this name and type in use.
2790 The symbol is weak (w) or strong (a space).
2793 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2796 The symbol is a warning (W) or a normal symbol (a space). A warning
2797 symbol's name is a message to be displayed if the symbol following the
2798 warning symbol is ever referenced.
2802 The symbol is an indirect reference to another symbol (I), a function
2803 to be evaluated during reloc processing (i) or a normal symbol (a
2808 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2809 normal symbol (a space).
2814 The symbol is the name of a function (F) or a file (f) or an object
2815 (O) or just a normal symbol (a space).
2819 @itemx --dynamic-syms
2820 @cindex dynamic symbol table entries, printing
2821 Print the dynamic symbol table entries of the file. This is only
2822 meaningful for dynamic objects, such as certain types of shared
2823 libraries. This is similar to the information provided by the @samp{nm}
2824 program when given the @option{-D} (@option{--dynamic}) option.
2826 The output format is similar to that produced by the @option{--syms}
2827 option, except that an extra field is inserted before the symbol's
2828 name, giving the version information associated with the symbol.
2829 If the version is the default version to be used when resolving
2830 unversioned references to the symbol then it's displayed as is,
2831 otherwise it's put into parentheses.
2833 @item --special-syms
2834 When displaying symbols include those which the target considers to be
2835 special in some way and which would not normally be of interest to the
2840 Print the version number of @command{objdump} and exit.
2843 @itemx --all-headers
2844 @cindex all header information, object file
2845 @cindex header information, all
2846 Display all available header information, including the symbol table and
2847 relocation entries. Using @option{-x} is equivalent to specifying all of
2848 @option{-a -f -h -p -r -t}.
2852 @cindex wide output, printing
2853 Format some lines for output devices that have more than 80 columns.
2854 Also do not truncate symbol names when they are displayed.
2857 @itemx --disassemble-zeroes
2858 Normally the disassembly output will skip blocks of zeroes. This
2859 option directs the disassembler to disassemble those blocks, just like
2866 @c man begin SEEALSO objdump
2867 nm(1), readelf(1), and the Info entries for @file{binutils}.
2875 @cindex archive contents
2876 @cindex symbol index
2878 @c man title ranlib generate an index to an archive
2881 @c man begin SYNOPSIS ranlib
2882 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2886 @c man begin DESCRIPTION ranlib
2888 @command{ranlib} generates an index to the contents of an archive and
2889 stores it in the archive. The index lists each symbol defined by a
2890 member of an archive that is a relocatable object file.
2892 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2894 An archive with such an index speeds up linking to the library and
2895 allows routines in the library to call each other without regard to
2896 their placement in the archive.
2898 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2899 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2904 @c man begin OPTIONS ranlib
2910 Show usage information for @command{ranlib}.
2915 Show the version number of @command{ranlib}.
2918 @cindex deterministic archives
2919 @kindex --enable-deterministic-archives
2920 Operate in @emph{deterministic} mode. The symbol map archive member's
2921 header will show zero for the UID, GID, and timestamp. When this
2922 option is used, multiple runs will produce identical output files.
2924 If @file{binutils} was configured with
2925 @option{--enable-deterministic-archives}, then this mode is on by
2926 default. It can be disabled with the @samp{-U} option, described
2930 Update the timestamp of the symbol map of an archive.
2933 @cindex deterministic archives
2934 @kindex --enable-deterministic-archives
2935 Do @emph{not} operate in @emph{deterministic} mode. This is the
2936 inverse of the @samp{-D} option, above: the archive index will get
2937 actual UID, GID, timestamp, and file mode values.
2939 If @file{binutils} was configured @emph{without}
2940 @option{--enable-deterministic-archives}, then this mode is on by
2948 @c man begin SEEALSO ranlib
2949 ar(1), nm(1), and the Info entries for @file{binutils}.
2957 @cindex section sizes
2959 @c man title size list section sizes and total size of binary files
2962 @c man begin SYNOPSIS size
2963 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
2965 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2967 [@option{-t}|@option{--totals}]
2968 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2969 [@var{objfile}@dots{}]
2973 @c man begin DESCRIPTION size
2975 The @sc{gnu} @command{size} utility lists the section sizes and the total
2976 size for each of the binary files @var{objfile} on its argument list.
2977 By default, one line of output is generated for each file or each
2978 module if the file is an archive.
2980 @var{objfile}@dots{} are the files to be examined. If none are
2981 specified, the file @code{a.out} will be used instead.
2985 @c man begin OPTIONS size
2987 The command-line options have the following meanings:
2993 @itemx --format=@var{compatibility}
2994 @cindex @command{size} display format
2995 Using one of these options, you can choose whether the output from @sc{gnu}
2996 @command{size} resembles output from System V @command{size} (using @option{-A},
2997 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2998 @option{--format=berkeley}). The default is the one-line format similar to
2999 Berkeley's. Alternatively, you can choose the GNU format output
3000 (using @option{-G}, or @option{--format=gnu}), this is similar to
3001 Berkeley's output format, but sizes are counted differently.
3002 @c Bonus for doc-source readers: you can also say --format=strange (or
3003 @c anything else that starts with 's') for sysv, and --format=boring (or
3004 @c anything else that starts with 'b') for Berkeley.
3006 Here is an example of the Berkeley (default) format of output from
3009 $ size --format=Berkeley ranlib size
3010 text data bss dec hex filename
3011 294880 81920 11592 388392 5ed28 ranlib
3012 294880 81920 11888 388688 5ee50 size
3015 The Berkeley style output counts read only data in the @code{text}
3016 column, not in the @code{data} column, the @code{dec} and @code{hex}
3017 columns both display the sum of the @code{text}, @code{data}, and
3018 @code{bss} columns in decimal and hexadecimal respectively.
3020 The GNU format counts read only data in the @code{data} column, not
3021 the @code{text} column, and only displays the sum of the @code{text},
3022 @code{data}, and @code{bss} columns once, in the @code{total} column.
3023 The @option{--radix} option can be used to change the number base for
3024 all columns. Here is the same data displayed with GNU conventions:
3027 $ size --format=GNU ranlib size
3028 text data bss total filename
3029 279880 96920 11592 388392 ranlib
3030 279880 96920 11888 388688 size
3034 This is the same data, but displayed closer to System V conventions:
3037 $ size --format=SysV ranlib size
3055 Show a summary of acceptable arguments and options.
3060 @itemx --radix=@var{number}
3061 @cindex @command{size} number format
3062 @cindex radix for section sizes
3063 Using one of these options, you can control whether the size of each
3064 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3065 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3066 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
3067 values (8, 10, 16) are supported. The total size is always given in two
3068 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3069 octal and hexadecimal if you're using @option{-o}.
3072 Print total size of common symbols in each file. When using Berkeley
3073 or GNU format these are included in the bss size.
3077 Show totals of all objects listed (Berkeley or GNU format mode only).
3079 @item --target=@var{bfdname}
3080 @cindex object code format
3081 Specify that the object-code format for @var{objfile} is
3082 @var{bfdname}. This option may not be necessary; @command{size} can
3083 automatically recognize many formats.
3084 @xref{Target Selection}, for more information.
3088 Display the version number of @command{size}.
3094 @c man begin SEEALSO size
3095 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3102 @cindex listings strings
3103 @cindex printing strings
3104 @cindex strings, printing
3106 @c man title strings print the sequences of printable characters in files
3109 @c man begin SYNOPSIS strings
3110 strings [@option{-afovV}] [@option{-}@var{min-len}]
3111 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3112 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3113 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3114 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3115 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3116 [@option{-w}] [@option{--include-all-whitespace}]
3117 [@option{-s}] [@option{--output-separator}@var{sep_string}]
3118 [@option{--help}] [@option{--version}] @var{file}@dots{}
3122 @c man begin DESCRIPTION strings
3124 For each @var{file} given, @sc{gnu} @command{strings} prints the
3125 printable character sequences that are at least 4 characters long (or
3126 the number given with the options below) and are followed by an
3127 unprintable character.
3129 Depending upon how the strings program was configured it will default
3130 to either displaying all the printable sequences that it can find in
3131 each file, or only those sequences that are in loadable, initialized
3132 data sections. If the file type is unrecognizable, or if strings is
3133 reading from stdin then it will always display all of the printable
3134 sequences that it can find.
3136 For backwards compatibility any file that occurs after a command-line
3137 option of just @option{-} will also be scanned in full, regardless of
3138 the presence of any @option{-d} option.
3140 @command{strings} is mainly useful for determining the contents of
3145 @c man begin OPTIONS strings
3151 Scan the whole file, regardless of what sections it contains or
3152 whether those sections are loaded or initialized. Normally this is
3153 the default behaviour, but strings can be configured so that the
3154 @option{-d} is the default instead.
3156 The @option{-} option is position dependent and forces strings to
3157 perform full scans of any file that is mentioned after the @option{-}
3158 on the command line, even if the @option{-d} option has been
3163 Only print strings from initialized, loaded data sections in the
3164 file. This may reduce the amount of garbage in the output, but it
3165 also exposes the strings program to any security flaws that may be
3166 present in the BFD library used to scan and load sections. Strings
3167 can be configured so that this option is the default behaviour. In
3168 such cases the @option{-a} option can be used to avoid using the BFD
3169 library and instead just print all of the strings found in the file.
3172 @itemx --print-file-name
3173 Print the name of the file before each string.
3176 Print a summary of the program usage on the standard output and exit.
3178 @item -@var{min-len}
3179 @itemx -n @var{min-len}
3180 @itemx --bytes=@var{min-len}
3181 Print sequences of characters that are at least @var{min-len} characters
3182 long, instead of the default 4.
3185 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3186 act like @samp{-t d} instead. Since we can not be compatible with both
3187 ways, we simply chose one.
3189 @item -t @var{radix}
3190 @itemx --radix=@var{radix}
3191 Print the offset within the file before each string. The single
3192 character argument specifies the radix of the offset---@samp{o} for
3193 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3195 @item -e @var{encoding}
3196 @itemx --encoding=@var{encoding}
3197 Select the character encoding of the strings that are to be found.
3198 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3199 characters (ASCII, ISO 8859, etc., default), @samp{S} =
3200 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3201 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3202 littleendian. Useful for finding wide character strings. (@samp{l}
3203 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3205 @item -T @var{bfdname}
3206 @itemx --target=@var{bfdname}
3207 @cindex object code format
3208 Specify an object code format other than your system's default format.
3209 @xref{Target Selection}, for more information.
3214 Print the program version number on the standard output and exit.
3217 @itemx --include-all-whitespace
3218 By default tab and space characters are included in the strings that
3219 are displayed, but other whitespace characters, such a newlines and
3220 carriage returns, are not. The @option{-w} option changes this so
3221 that all whitespace characters are considered to be part of a string.
3224 @itemx --output-separator
3225 By default, output strings are delimited by a new-line. This option
3226 allows you to supply any string to be used as the output record
3227 separator. Useful with --include-all-whitespace where strings
3228 may contain new-lines internally.
3234 @c man begin SEEALSO strings
3235 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3236 and the Info entries for @file{binutils}.
3244 @cindex removing symbols
3245 @cindex discarding symbols
3246 @cindex symbols, discarding
3248 @c man title strip discard symbols and other data from object files
3251 @c man begin SYNOPSIS strip
3252 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3253 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3254 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3255 [@option{-s}|@option{--strip-all}]
3256 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3257 [@option{--strip-dwo}]
3258 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3259 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3260 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3261 [@option{-w}|@option{--wildcard}]
3262 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3263 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3264 [@option{--keep-section=}@var{sectionpattern}]
3265 [@option{--remove-relocations=}@var{sectionpattern}]
3266 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3267 [@option{-D}|@option{--enable-deterministic-archives}]
3268 [@option{-U}|@option{--disable-deterministic-archives}]
3269 [@option{--keep-file-symbols}]
3270 [@option{--only-keep-debug}]
3271 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3272 [@option{--help}] [@option{--info}]
3273 @var{objfile}@dots{}
3277 @c man begin DESCRIPTION strip
3279 @sc{gnu} @command{strip} discards all symbols from object files
3280 @var{objfile}. The list of object files may include archives.
3281 At least one object file must be given.
3283 @command{strip} modifies the files named in its argument,
3284 rather than writing modified copies under different names.
3288 @c man begin OPTIONS strip
3291 @item -F @var{bfdname}
3292 @itemx --target=@var{bfdname}
3293 Treat the original @var{objfile} as a file with the object
3294 code format @var{bfdname}, and rewrite it in the same format.
3295 @xref{Target Selection}, for more information.
3298 Show a summary of the options to @command{strip} and exit.
3301 Display a list showing all architectures and object formats available.
3303 @item -I @var{bfdname}
3304 @itemx --input-target=@var{bfdname}
3305 Treat the original @var{objfile} as a file with the object
3306 code format @var{bfdname}.
3307 @xref{Target Selection}, for more information.
3309 @item -O @var{bfdname}
3310 @itemx --output-target=@var{bfdname}
3311 Replace @var{objfile} with a file in the output format @var{bfdname}.
3312 @xref{Target Selection}, for more information.
3314 @item -R @var{sectionname}
3315 @itemx --remove-section=@var{sectionname}
3316 Remove any section named @var{sectionname} from the output file, in
3317 addition to whatever sections would otherwise be removed. This
3318 option may be given more than once. Note that using this option
3319 inappropriately may make the output file unusable. The wildcard
3320 character @samp{*} may be given at the end of @var{sectionname}. If
3321 so, then any section starting with @var{sectionname} will be removed.
3323 If the first character of @var{sectionpattern} is the exclamation
3324 point (!) then matching sections will not be removed even if an
3325 earlier use of @option{--remove-section} on the same command line
3326 would otherwise remove it. For example:
3329 --remove-section=.text.* --remove-section=!.text.foo
3332 will remove all sections matching the pattern '.text.*', but will not
3333 remove the section '.text.foo'.
3335 @item --keep-section=@var{sectionpattern}
3336 When removing sections from the output file, keep sections that match
3337 @var{sectionpattern}.
3339 @item --remove-relocations=@var{sectionpattern}
3340 Remove relocations from the output file for any section matching
3341 @var{sectionpattern}. This option may be given more than once. Note
3342 that using this option inappropriately may make the output file
3343 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3347 --remove-relocations=.text.*
3350 will remove the relocations for all sections matching the patter
3353 If the first character of @var{sectionpattern} is the exclamation
3354 point (!) then matching sections will not have their relocation
3355 removed even if an earlier use of @option{--remove-relocations} on the
3356 same command line would otherwise cause the relocations to be removed.
3360 --remove-relocations=.text.* --remove-relocations=!.text.foo
3363 will remove all relocations for sections matching the pattern
3364 '.text.*', but will not remove relocations for the section
3374 @itemx --strip-debug
3375 Remove debugging symbols only.
3378 Remove the contents of all DWARF .dwo sections, leaving the
3379 remaining debugging sections and all symbols intact.
3380 See the description of this option in the @command{objcopy} section
3381 for more information.
3383 @item --strip-unneeded
3384 Remove all symbols that are not needed for relocation processing.
3386 @item -K @var{symbolname}
3387 @itemx --keep-symbol=@var{symbolname}
3388 When stripping symbols, keep symbol @var{symbolname} even if it would
3389 normally be stripped. This option may be given more than once.
3392 @itemx --merge-notes
3393 @itemx --no-merge-notes
3394 For ELF files, attempt (or do not attempt) to reduce the size of any
3395 SHT_NOTE type sections by removing duplicate notes. The default is to
3396 attempt this reduction unless stripping debug or DWO information.
3398 @item -N @var{symbolname}
3399 @itemx --strip-symbol=@var{symbolname}
3400 Remove symbol @var{symbolname} from the source file. This option may be
3401 given more than once, and may be combined with strip options other than
3405 Put the stripped output in @var{file}, rather than replacing the
3406 existing file. When this argument is used, only one @var{objfile}
3407 argument may be specified.
3410 @itemx --preserve-dates
3411 Preserve the access and modification dates of the file.
3414 @itemx --enable-deterministic-archives
3415 @cindex deterministic archives
3416 @kindex --enable-deterministic-archives
3417 Operate in @emph{deterministic} mode. When copying archive members
3418 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3419 and use consistent file modes for all files.
3421 If @file{binutils} was configured with
3422 @option{--enable-deterministic-archives}, then this mode is on by default.
3423 It can be disabled with the @samp{-U} option, below.
3426 @itemx --disable-deterministic-archives
3427 @cindex deterministic archives
3428 @kindex --enable-deterministic-archives
3429 Do @emph{not} operate in @emph{deterministic} mode. This is the
3430 inverse of the @option{-D} option, above: when copying archive members
3431 and writing the archive index, use their actual UID, GID, timestamp,
3432 and file mode values.
3434 This is the default unless @file{binutils} was configured with
3435 @option{--enable-deterministic-archives}.
3439 Permit regular expressions in @var{symbolname}s used in other command
3440 line options. The question mark (?), asterisk (*), backslash (\) and
3441 square brackets ([]) operators can be used anywhere in the symbol
3442 name. If the first character of the symbol name is the exclamation
3443 point (!) then the sense of the switch is reversed for that symbol.
3450 would cause strip to only keep symbols that start with the letters
3451 ``fo'', but to discard the symbol ``foo''.
3454 @itemx --discard-all
3455 Remove non-global symbols.
3458 @itemx --discard-locals
3459 Remove compiler-generated local symbols.
3460 (These usually start with @samp{L} or @samp{.}.)
3462 @item --keep-file-symbols
3463 When stripping a file, perhaps with @option{--strip-debug} or
3464 @option{--strip-unneeded}, retain any symbols specifying source file names,
3465 which would otherwise get stripped.
3467 @item --only-keep-debug
3468 Strip a file, emptying the contents of any sections that would not be
3469 stripped by @option{--strip-debug} and leaving the debugging sections
3470 intact. In ELF files, this preserves all the note sections in the
3473 Note - the section headers of the stripped sections are preserved,
3474 including their sizes, but the contents of the section are discarded.
3475 The section headers are preserved so that other tools can match up the
3476 debuginfo file with the real executable, even if that executable has
3477 been relocated to a different address space.
3479 The intention is that this option will be used in conjunction with
3480 @option{--add-gnu-debuglink} to create a two part executable. One a
3481 stripped binary which will occupy less space in RAM and in a
3482 distribution and the second a debugging information file which is only
3483 needed if debugging abilities are required. The suggested procedure
3484 to create these files is as follows:
3487 @item Link the executable as normal. Assuming that it is called
3489 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3490 create a file containing the debugging info.
3491 @item Run @code{objcopy --strip-debug foo} to create a
3492 stripped executable.
3493 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3494 to add a link to the debugging info into the stripped executable.
3497 Note---the choice of @code{.dbg} as an extension for the debug info
3498 file is arbitrary. Also the @code{--only-keep-debug} step is
3499 optional. You could instead do this:
3502 @item Link the executable as normal.
3503 @item Copy @code{foo} to @code{foo.full}
3504 @item Run @code{strip --strip-debug foo}
3505 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3508 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3509 full executable. It does not have to be a file created by the
3510 @option{--only-keep-debug} switch.
3512 Note---this switch is only intended for use on fully linked files. It
3513 does not make sense to use it on object files where the debugging
3514 information may be incomplete. Besides the gnu_debuglink feature
3515 currently only supports the presence of one filename containing
3516 debugging information, not multiple filenames on a one-per-object-file
3521 Show the version number for @command{strip}.
3525 Verbose output: list all object files modified. In the case of
3526 archives, @samp{strip -v} lists all members of the archive.
3532 @c man begin SEEALSO strip
3533 the Info entries for @file{binutils}.
3537 @node c++filt, addr2line, strip, Top
3541 @cindex demangling C++ symbols
3543 @c man title cxxfilt demangle C++ and Java symbols
3546 @c man begin SYNOPSIS cxxfilt
3547 c++filt [@option{-_}|@option{--strip-underscore}]
3548 [@option{-n}|@option{--no-strip-underscore}]
3549 [@option{-p}|@option{--no-params}]
3550 [@option{-t}|@option{--types}]
3551 [@option{-i}|@option{--no-verbose}]
3552 [@option{-r}|@option{--no-recurse-limit}]
3553 [@option{-R}|@option{--recurse-limit}]
3554 [@option{-s} @var{format}|@option{--format=}@var{format}]
3555 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3559 @c man begin DESCRIPTION cxxfilt
3562 The C++ and Java languages provide function overloading, which means
3563 that you can write many functions with the same name, providing that
3564 each function takes parameters of different types. In order to be
3565 able to distinguish these similarly named functions C++ and Java
3566 encode them into a low-level assembler name which uniquely identifies
3567 each different version. This process is known as @dfn{mangling}. The
3569 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3570 MS-DOS this program is named @command{CXXFILT}.}
3571 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3572 names into user-level names so that they can be read.
3574 Every alphanumeric word (consisting of letters, digits, underscores,
3575 dollars, or periods) seen in the input is a potential mangled name.
3576 If the name decodes into a C++ name, the C++ name replaces the
3577 low-level name in the output, otherwise the original word is output.
3578 In this way you can pass an entire assembler source file, containing
3579 mangled names, through @command{c++filt} and see the same source file
3580 containing demangled names.
3582 You can also use @command{c++filt} to decipher individual symbols by
3583 passing them on the command line:
3586 c++filt @var{symbol}
3589 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3590 names from the standard input instead. All the results are printed on
3591 the standard output. The difference between reading names from the
3592 command line versus reading names from the standard input is that
3593 command-line arguments are expected to be just mangled names and no
3594 checking is performed to separate them from surrounding text. Thus
3601 will work and demangle the name to ``f()'' whereas:
3607 will not work. (Note the extra comma at the end of the mangled
3608 name which makes it invalid). This command however will work:
3611 echo _Z1fv, | c++filt -n
3614 and will display ``f(),'', i.e., the demangled name followed by a
3615 trailing comma. This behaviour is because when the names are read
3616 from the standard input it is expected that they might be part of an
3617 assembler source file where there might be extra, extraneous
3618 characters trailing after a mangled name. For example:
3621 .type _Z1fv, @@function
3626 @c man begin OPTIONS cxxfilt
3630 @itemx --strip-underscore
3631 On some systems, both the C and C++ compilers put an underscore in front
3632 of every name. For example, the C name @code{foo} gets the low-level
3633 name @code{_foo}. This option removes the initial underscore. Whether
3634 @command{c++filt} removes the underscore by default is target dependent.
3637 @itemx --no-strip-underscore
3638 Do not remove the initial underscore.
3642 When demangling the name of a function, do not display the types of
3643 the function's parameters.
3647 Attempt to demangle types as well as function names. This is disabled
3648 by default since mangled types are normally only used internally in
3649 the compiler, and they can be confused with non-mangled names. For example,
3650 a function called ``a'' treated as a mangled type name would be
3651 demangled to ``signed char''.
3655 Do not include implementation details (if any) in the demangled
3660 @itemx --recurse-limit
3661 @itemx --no-recurse-limit
3662 @itemx --recursion-limit
3663 @itemx --no-recursion-limit
3664 Enables or disables a limit on the amount of recursion performed
3665 whilst demangling strings. Since the name mangling formats allow for
3666 an inifinite level of recursion it is possible to create strings whose
3667 decoding will exhaust the amount of stack space available on the host
3668 machine, triggering a memory fault. The limit tries to prevent this
3669 from happening by restricting recursion to 2048 levels of nesting.
3671 The default is for this limit to be enabled, but disabling it may be
3672 necessary in order to demangle truly complicated names. Note however
3673 that if the recursion limit is disabled then stack exhaustion is
3674 possible and any bug reports about such an event will be rejected.
3676 The @option{-r} option is a synonym for the
3677 @option{--no-recurse-limit} option. The @option{-R} option is a
3678 synonym for the @option{--recurse-limit} option.
3680 @item -s @var{format}
3681 @itemx --format=@var{format}
3682 @command{c++filt} can decode various methods of mangling, used by
3683 different compilers. The argument to this option selects which
3688 Automatic selection based on executable (the default method)
3690 the one used by the @sc{gnu} C++ compiler (g++)
3692 the one used by the Lucid compiler (lcc)
3694 the one specified by the C++ Annotated Reference Manual
3696 the one used by the HP compiler (aCC)
3698 the one used by the EDG compiler
3700 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3702 the one used by the @sc{gnu} Java compiler (gcj)
3704 the one used by the @sc{gnu} Ada compiler (GNAT).
3708 Print a summary of the options to @command{c++filt} and exit.
3711 Print the version number of @command{c++filt} and exit.
3717 @c man begin SEEALSO cxxfilt
3718 the Info entries for @file{binutils}.
3723 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3724 user interface are subject to change in future releases. In particular,
3725 a command-line option may be required in the future to decode a name
3726 passed as an argument on the command line; in other words,
3729 c++filt @var{symbol}
3733 may in a future release become
3736 c++filt @var{option} @var{symbol}
3744 @cindex address to file name and line number
3746 @c man title addr2line convert addresses into file names and line numbers
3749 @c man begin SYNOPSIS addr2line
3750 addr2line [@option{-a}|@option{--addresses}]
3751 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3752 [@option{-C}|@option{--demangle}[=@var{style}]]
3753 [@option{-r}|@option{--no-recurse-limit}]
3754 [@option{-R}|@option{--recurse-limit}]
3755 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3756 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3757 [@option{-i}|@option{--inlines}]
3758 [@option{-p}|@option{--pretty-print}]
3759 [@option{-j}|@option{--section=}@var{name}]
3760 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3765 @c man begin DESCRIPTION addr2line
3767 @command{addr2line} translates addresses into file names and line numbers.
3768 Given an address in an executable or an offset in a section of a relocatable
3769 object, it uses the debugging information to figure out which file name and
3770 line number are associated with it.
3772 The executable or relocatable object to use is specified with the @option{-e}
3773 option. The default is the file @file{a.out}. The section in the relocatable
3774 object to use is specified with the @option{-j} option.
3776 @command{addr2line} has two modes of operation.
3778 In the first, hexadecimal addresses are specified on the command line,
3779 and @command{addr2line} displays the file name and line number for each
3782 In the second, @command{addr2line} reads hexadecimal addresses from
3783 standard input, and prints the file name and line number for each
3784 address on standard output. In this mode, @command{addr2line} may be used
3785 in a pipe to convert dynamically chosen addresses.
3787 The format of the output is @samp{FILENAME:LINENO}. By default
3788 each input address generates one line of output.
3790 Two options can generate additional lines before each
3791 @samp{FILENAME:LINENO} line (in that order).
3793 If the @option{-a} option is used then a line with the input address
3796 If the @option{-f} option is used, then a line with the
3797 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3798 containing the address.
3800 One option can generate additional lines after the
3801 @samp{FILENAME:LINENO} line.
3803 If the @option{-i} option is used and the code at the given address is
3804 present there because of inlining by the compiler then additional
3805 lines are displayed afterwards. One or two extra lines (if the
3806 @option{-f} option is used) are displayed for each inlined function.
3808 Alternatively if the @option{-p} option is used then each input
3809 address generates a single, long, output line containing the address,
3810 the function name, the file name and the line number. If the
3811 @option{-i} option has also been used then any inlined functions will
3812 be displayed in the same manner, but on separate lines, and prefixed
3813 by the text @samp{(inlined by)}.
3815 If the file name or function name can not be determined,
3816 @command{addr2line} will print two question marks in their place. If the
3817 line number can not be determined, @command{addr2line} will print 0.
3821 @c man begin OPTIONS addr2line
3823 The long and short forms of options, shown here as alternatives, are
3829 Display the address before the function name, file and line number
3830 information. The address is printed with a @samp{0x} prefix to easily
3833 @item -b @var{bfdname}
3834 @itemx --target=@var{bfdname}
3835 @cindex object code format
3836 Specify that the object-code format for the object files is
3840 @itemx --demangle[=@var{style}]
3841 @cindex demangling in objdump
3842 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3843 Besides removing any initial underscore prepended by the system, this
3844 makes C++ function names readable. Different compilers have different
3845 mangling styles. The optional demangling style argument can be used to
3846 choose an appropriate demangling style for your compiler. @xref{c++filt},
3847 for more information on demangling.
3849 @item -e @var{filename}
3850 @itemx --exe=@var{filename}
3851 Specify the name of the executable for which addresses should be
3852 translated. The default file is @file{a.out}.
3856 Display function names as well as file and line number information.
3860 Display only the base of each file name.
3864 If the address belongs to a function that was inlined, the source
3865 information for all enclosing scopes back to the first non-inlined
3866 function will also be printed. For example, if @code{main} inlines
3867 @code{callee1} which inlines @code{callee2}, and address is from
3868 @code{callee2}, the source information for @code{callee1} and @code{main}
3869 will also be printed.
3873 Read offsets relative to the specified section instead of absolute addresses.
3876 @itemx --pretty-print
3877 Make the output more human friendly: each location are printed on one line.
3878 If option @option{-i} is specified, lines for all enclosing scopes are
3879 prefixed with @samp{(inlined by)}.
3883 @itemx --recurse-limit
3884 @itemx --no-recurse-limit
3885 @itemx --recursion-limit
3886 @itemx --no-recursion-limit
3887 Enables or disables a limit on the amount of recursion performed
3888 whilst demangling strings. Since the name mangling formats allow for
3889 an inifinite level of recursion it is possible to create strings whose
3890 decoding will exhaust the amount of stack space available on the host
3891 machine, triggering a memory fault. The limit tries to prevent this
3892 from happening by restricting recursion to 2048 levels of nesting.
3894 The default is for this limit to be enabled, but disabling it may be
3895 necessary in order to demangle truly complicated names. Note however
3896 that if the recursion limit is disabled then stack exhaustion is
3897 possible and any bug reports about such an event will be rejected.
3899 The @option{-r} option is a synonym for the
3900 @option{--no-recurse-limit} option. The @option{-R} option is a
3901 synonym for the @option{--recurse-limit} option.
3903 Note this option is only effective if the @option{-C} or
3904 @option{--demangle} option has been enabled.
3911 @c man begin SEEALSO addr2line
3912 Info entries for @file{binutils}.
3919 @command{windmc} may be used to generator Windows message resources.
3922 @emph{Warning:} @command{windmc} is not always built as part of the binary
3923 utilities, since it is only useful for Windows targets.
3926 @c man title windmc generates Windows message resources
3929 @c man begin SYNOPSIS windmc
3930 windmc [options] input-file
3934 @c man begin DESCRIPTION windmc
3936 @command{windmc} reads message definitions from an input file (.mc) and
3937 translate them into a set of output files. The output files may be of
3942 A C header file containing the message definitions.
3945 A resource file compilable by the @command{windres} tool.
3948 One or more binary files containing the resource data for a specific
3952 A C include file that maps message id's to their symbolic name.
3955 The exact description of these different formats is available in
3956 documentation from Microsoft.
3958 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3959 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3960 Windows Message Compiler.
3964 @c man begin OPTIONS windmc
3969 Specifies that the input file specified is ASCII. This is the default
3974 Specifies that messages in the output @code{bin} files should be in ASCII
3979 Specifies that @code{bin} filenames should have to be prefixed by the
3980 basename of the source file.
3984 Sets the customer bit in all message id's.
3986 @item -C @var{codepage}
3987 @itemx --codepage_in @var{codepage}
3988 Sets the default codepage to be used to convert input file to UTF16. The
3989 default is ocdepage 1252.
3992 @itemx --decimal_values
3993 Outputs the constants in the header file in decimal. Default is using
3997 @itemx --extension @var{ext}
3998 The extension for the header file. The default is .h extension.
4000 @item -F @var{target}
4001 @itemx --target @var{target}
4002 Specify the BFD format to use for a bin file as output. This
4003 is a BFD target name; you can use the @option{--help} option to see a list
4004 of supported targets. Normally @command{windmc} will use the default
4005 format, which is the first one listed by the @option{--help} option.
4007 @ref{Target Selection}.
4011 @itemx --headerdir @var{path}
4012 The target directory of the generated header file. The default is the
4017 Displays a list of command-line options and then exits.
4019 @item -m @var{characters}
4020 @itemx --maxlength @var{characters}
4021 Instructs @command{windmc} to generate a warning if the length
4022 of any message exceeds the number specified.
4025 @itemx --nullterminate
4026 Terminate message text in @code{bin} files by zero. By default they are
4027 terminated by CR/LF.
4030 @itemx --hresult_use
4031 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
4032 file, using HRESULT definitions. Status codes are used if the flag is not
4035 @item -O @var{codepage}
4036 @itemx --codepage_out @var{codepage}
4037 Sets the default codepage to be used to output text files. The default
4041 @itemx --rcdir @var{path}
4042 The target directory for the generated @code{rc} script and the generated
4043 @code{bin} files that the resource compiler script includes. The default
4044 is the current directory.
4048 Specifies that the input file is UTF16.
4051 @itemx --unicode_out
4052 Specifies that messages in the output @code{bin} file should be in UTF16
4053 format. This is the default behaviour.
4057 Enable verbose mode.
4061 Prints the version number for @command{windmc}.
4064 @itemx --xdgb @var{path}
4065 The path of the @code{dbg} C include file that maps message id's to the
4066 symbolic name. No such file is generated without specifying the switch.
4072 @c man begin SEEALSO windmc
4073 the Info entries for @file{binutils}.
4080 @command{windres} may be used to manipulate Windows resources.
4083 @emph{Warning:} @command{windres} is not always built as part of the binary
4084 utilities, since it is only useful for Windows targets.
4087 @c man title windres manipulate Windows resources
4090 @c man begin SYNOPSIS windres
4091 windres [options] [input-file] [output-file]
4095 @c man begin DESCRIPTION windres
4097 @command{windres} reads resources from an input file and copies them into
4098 an output file. Either file may be in one of three formats:
4102 A text format read by the Resource Compiler.
4105 A binary format generated by the Resource Compiler.
4108 A COFF object or executable.
4111 The exact description of these different formats is available in
4112 documentation from Microsoft.
4114 When @command{windres} converts from the @code{rc} format to the @code{res}
4115 format, it is acting like the Windows Resource Compiler. When
4116 @command{windres} converts from the @code{res} format to the @code{coff}
4117 format, it is acting like the Windows @code{CVTRES} program.
4119 When @command{windres} generates an @code{rc} file, the output is similar
4120 but not identical to the format expected for the input. When an input
4121 @code{rc} file refers to an external filename, an output @code{rc} file
4122 will instead include the file contents.
4124 If the input or output format is not specified, @command{windres} will
4125 guess based on the file name, or, for the input file, the file contents.
4126 A file with an extension of @file{.rc} will be treated as an @code{rc}
4127 file, a file with an extension of @file{.res} will be treated as a
4128 @code{res} file, and a file with an extension of @file{.o} or
4129 @file{.exe} will be treated as a @code{coff} file.
4131 If no output file is specified, @command{windres} will print the resources
4132 in @code{rc} format to standard output.
4134 The normal use is for you to write an @code{rc} file, use @command{windres}
4135 to convert it to a COFF object file, and then link the COFF file into
4136 your application. This will make the resources described in the
4137 @code{rc} file available to Windows.
4141 @c man begin OPTIONS windres
4144 @item -i @var{filename}
4145 @itemx --input @var{filename}
4146 The name of the input file. If this option is not used, then
4147 @command{windres} will use the first non-option argument as the input file
4148 name. If there are no non-option arguments, then @command{windres} will
4149 read from standard input. @command{windres} can not read a COFF file from
4152 @item -o @var{filename}
4153 @itemx --output @var{filename}
4154 The name of the output file. If this option is not used, then
4155 @command{windres} will use the first non-option argument, after any used
4156 for the input file name, as the output file name. If there is no
4157 non-option argument, then @command{windres} will write to standard output.
4158 @command{windres} can not write a COFF file to standard output. Note,
4159 for compatibility with @command{rc} the option @option{-fo} is also
4160 accepted, but its use is not recommended.
4162 @item -J @var{format}
4163 @itemx --input-format @var{format}
4164 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4165 @samp{coff}. If no input format is specified, @command{windres} will
4166 guess, as described above.
4168 @item -O @var{format}
4169 @itemx --output-format @var{format}
4170 The output format to generate. @var{format} may be @samp{res},
4171 @samp{rc}, or @samp{coff}. If no output format is specified,
4172 @command{windres} will guess, as described above.
4174 @item -F @var{target}
4175 @itemx --target @var{target}
4176 Specify the BFD format to use for a COFF file as input or output. This
4177 is a BFD target name; you can use the @option{--help} option to see a list
4178 of supported targets. Normally @command{windres} will use the default
4179 format, which is the first one listed by the @option{--help} option.
4181 @ref{Target Selection}.
4184 @item --preprocessor @var{program}
4185 When @command{windres} reads an @code{rc} file, it runs it through the C
4186 preprocessor first. This option may be used to specify the preprocessor
4187 to use, including any leading arguments. The default preprocessor
4188 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4190 @item --preprocessor-arg @var{option}
4191 When @command{windres} reads an @code{rc} file, it runs it through
4192 the C preprocessor first. This option may be used to specify additional
4193 text to be passed to preprocessor on its command line.
4194 This option can be used multiple times to add multiple options to the
4195 preprocessor command line.
4197 @item -I @var{directory}
4198 @itemx --include-dir @var{directory}
4199 Specify an include directory to use when reading an @code{rc} file.
4200 @command{windres} will pass this to the preprocessor as an @option{-I}
4201 option. @command{windres} will also search this directory when looking for
4202 files named in the @code{rc} file. If the argument passed to this command
4203 matches any of the supported @var{formats} (as described in the @option{-J}
4204 option), it will issue a deprecation warning, and behave just like the
4205 @option{-J} option. New programs should not use this behaviour. If a
4206 directory happens to match a @var{format}, simple prefix it with @samp{./}
4207 to disable the backward compatibility.
4209 @item -D @var{target}
4210 @itemx --define @var{sym}[=@var{val}]
4211 Specify a @option{-D} option to pass to the preprocessor when reading an
4214 @item -U @var{target}
4215 @itemx --undefine @var{sym}
4216 Specify a @option{-U} option to pass to the preprocessor when reading an
4220 Ignored for compatibility with rc.
4223 Enable verbose mode. This tells you what the preprocessor is if you
4227 @item --codepage @var{val}
4228 Specify the default codepage to use when reading an @code{rc} file.
4229 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4230 codepage code. The valid range is from zero up to 0xffff, but the
4231 validity of the codepage is host and configuration dependent.
4234 @item --language @var{val}
4235 Specify the default language to use when reading an @code{rc} file.
4236 @var{val} should be a hexadecimal language code. The low eight bits are
4237 the language, and the high eight bits are the sublanguage.
4239 @item --use-temp-file
4240 Use a temporary file to instead of using popen to read the output of
4241 the preprocessor. Use this option if the popen implementation is buggy
4242 on the host (eg., certain non-English language versions of Windows 95 and
4243 Windows 98 are known to have buggy popen where the output will instead
4246 @item --no-use-temp-file
4247 Use popen, not a temporary file, to read the output of the preprocessor.
4248 This is the default behaviour.
4252 Prints a usage summary.
4256 Prints the version number for @command{windres}.
4259 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4260 this will turn on parser debugging.
4266 @c man begin SEEALSO windres
4267 the Info entries for @file{binutils}.
4276 @command{dlltool} is used to create the files needed to create dynamic
4277 link libraries (DLLs) on systems which understand PE format image
4278 files such as Windows. A DLL contains an export table which contains
4279 information that the runtime loader needs to resolve references from a
4280 referencing program.
4282 The export table is generated by this program by reading in a
4283 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4284 will be in the DLL. A @file{.o} file can contain information in
4285 special @samp{.drectve} sections with export information.
4288 @emph{Note:} @command{dlltool} is not always built as part of the
4289 binary utilities, since it is only useful for those targets which
4293 @c man title dlltool create files needed to build and use DLLs
4296 @c man begin SYNOPSIS dlltool
4297 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4298 [@option{-b}|@option{--base-file} @var{base-file-name}]
4299 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4300 [@option{-z}|@option{--output-def} @var{def-file-name}]
4301 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4302 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4303 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4304 [@option{--exclude-symbols} @var{list}]
4305 [@option{--no-default-excludes}]
4306 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4307 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4308 [@option{-a}|@option{--add-indirect}]
4309 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4310 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4311 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4312 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4313 [@option{--use-nul-prefixed-import-tables}]
4314 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4315 [@option{-i}|@option{--interwork}]
4316 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4317 [@option{-v}|@option{--verbose}]
4318 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4319 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4320 [object-file @dots{}]
4324 @c man begin DESCRIPTION dlltool
4326 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4327 @option{-b} options as well as object files specified on the command
4328 line. It then processes these inputs and if the @option{-e} option has
4329 been specified it creates a exports file. If the @option{-l} option
4330 has been specified it creates a library file and if the @option{-z} option
4331 has been specified it creates a def file. Any or all of the @option{-e},
4332 @option{-l} and @option{-z} options can be present in one invocation of
4335 When creating a DLL, along with the source for the DLL, it is necessary
4336 to have three other files. @command{dlltool} can help with the creation of
4339 The first file is a @file{.def} file which specifies which functions are
4340 exported from the DLL, which functions the DLL imports, and so on. This
4341 is a text file and can be created by hand, or @command{dlltool} can be used
4342 to create it using the @option{-z} option. In this case @command{dlltool}
4343 will scan the object files specified on its command line looking for
4344 those functions which have been specially marked as being exported and
4345 put entries for them in the @file{.def} file it creates.
4347 In order to mark a function as being exported from a DLL, it needs to
4348 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4349 section of the object file. This can be done in C by using the
4353 asm (".section .drectve");
4354 asm (".ascii \"-export:my_func\"");
4356 int my_func (void) @{ @dots{} @}
4359 The second file needed for DLL creation is an exports file. This file
4360 is linked with the object files that make up the body of the DLL and it
4361 handles the interface between the DLL and the outside world. This is a
4362 binary file and it can be created by giving the @option{-e} option to
4363 @command{dlltool} when it is creating or reading in a @file{.def} file.
4365 The third file needed for DLL creation is the library file that programs
4366 will link with in order to access the functions in the DLL (an `import
4367 library'). This file can be created by giving the @option{-l} option to
4368 dlltool when it is creating or reading in a @file{.def} file.
4370 If the @option{-y} option is specified, dlltool generates a delay-import
4371 library that can be used instead of the normal import library to allow
4372 a program to link to the dll only as soon as an imported function is
4373 called for the first time. The resulting executable will need to be
4374 linked to the static delayimp library containing __delayLoadHelper2(),
4375 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4377 @command{dlltool} builds the library file by hand, but it builds the
4378 exports file by creating temporary files containing assembler statements
4379 and then assembling these. The @option{-S} command-line option can be
4380 used to specify the path to the assembler that dlltool will use,
4381 and the @option{-f} option can be used to pass specific flags to that
4382 assembler. The @option{-n} can be used to prevent dlltool from deleting
4383 these temporary assembler files when it is done, and if @option{-n} is
4384 specified twice then this will prevent dlltool from deleting the
4385 temporary object files it used to build the library.
4387 Here is an example of creating a DLL from a source file @samp{dll.c} and
4388 also creating a program (from an object file called @samp{program.o})
4393 dlltool -e exports.o -l dll.lib dll.o
4394 gcc dll.o exports.o -o dll.dll
4395 gcc program.o dll.lib -o program
4399 @command{dlltool} may also be used to query an existing import library
4400 to determine the name of the DLL to which it is associated. See the
4401 description of the @option{-I} or @option{--identify} option.
4405 @c man begin OPTIONS dlltool
4407 The command-line options have the following meanings:
4411 @item -d @var{filename}
4412 @itemx --input-def @var{filename}
4413 @cindex input .def file
4414 Specifies the name of a @file{.def} file to be read in and processed.
4416 @item -b @var{filename}
4417 @itemx --base-file @var{filename}
4419 Specifies the name of a base file to be read in and processed. The
4420 contents of this file will be added to the relocation section in the
4421 exports file generated by dlltool.
4423 @item -e @var{filename}
4424 @itemx --output-exp @var{filename}
4425 Specifies the name of the export file to be created by dlltool.
4427 @item -z @var{filename}
4428 @itemx --output-def @var{filename}
4429 Specifies the name of the @file{.def} file to be created by dlltool.
4431 @item -l @var{filename}
4432 @itemx --output-lib @var{filename}
4433 Specifies the name of the library file to be created by dlltool.
4435 @item -y @var{filename}
4436 @itemx --output-delaylib @var{filename}
4437 Specifies the name of the delay-import library file to be created by dlltool.
4439 @item --export-all-symbols
4440 Treat all global and weak defined symbols found in the input object
4441 files as symbols to be exported. There is a small list of symbols which
4442 are not exported by default; see the @option{--no-default-excludes}
4443 option. You may add to the list of symbols to not export by using the
4444 @option{--exclude-symbols} option.
4446 @item --no-export-all-symbols
4447 Only export symbols explicitly listed in an input @file{.def} file or in
4448 @samp{.drectve} sections in the input object files. This is the default
4449 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4450 attributes in the source code.
4452 @item --exclude-symbols @var{list}
4453 Do not export the symbols in @var{list}. This is a list of symbol names
4454 separated by comma or colon characters. The symbol names should not
4455 contain a leading underscore. This is only meaningful when
4456 @option{--export-all-symbols} is used.
4458 @item --no-default-excludes
4459 When @option{--export-all-symbols} is used, it will by default avoid
4460 exporting certain special symbols. The current list of symbols to avoid
4461 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4462 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4463 to go ahead and export these special symbols. This is only meaningful
4464 when @option{--export-all-symbols} is used.
4467 @itemx --as @var{path}
4468 Specifies the path, including the filename, of the assembler to be used
4469 to create the exports file.
4471 @item -f @var{options}
4472 @itemx --as-flags @var{options}
4473 Specifies any specific command-line options to be passed to the
4474 assembler when building the exports file. This option will work even if
4475 the @option{-S} option is not used. This option only takes one argument,
4476 and if it occurs more than once on the command line, then later
4477 occurrences will override earlier occurrences. So if it is necessary to
4478 pass multiple options to the assembler they should be enclosed in
4482 @itemx --dll-name @var{name}
4483 Specifies the name to be stored in the @file{.def} file as the name of
4484 the DLL when the @option{-e} option is used. If this option is not
4485 present, then the filename given to the @option{-e} option will be
4486 used as the name of the DLL.
4488 @item -m @var{machine}
4489 @itemx -machine @var{machine}
4490 Specifies the type of machine for which the library file should be
4491 built. @command{dlltool} has a built in default type, depending upon how
4492 it was created, but this option can be used to override that. This is
4493 normally only useful when creating DLLs for an ARM processor, when the
4494 contents of the DLL are actually encode using Thumb instructions.
4497 @itemx --add-indirect
4498 Specifies that when @command{dlltool} is creating the exports file it
4499 should add a section which allows the exported functions to be
4500 referenced without using the import library. Whatever the hell that
4504 @itemx --add-underscore
4505 Specifies that when @command{dlltool} is creating the exports file it
4506 should prepend an underscore to the names of @emph{all} exported symbols.
4508 @item --no-leading-underscore
4509 @item --leading-underscore
4510 Specifies whether standard symbol should be forced to be prefixed, or
4513 @item --add-stdcall-underscore
4514 Specifies that when @command{dlltool} is creating the exports file it
4515 should prepend an underscore to the names of exported @emph{stdcall}
4516 functions. Variable names and non-stdcall function names are not modified.
4517 This option is useful when creating GNU-compatible import libs for third
4518 party DLLs that were built with MS-Windows tools.
4522 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4523 of stdcall functions that will be imported from the DLL. This is
4524 useful when creating an import library for a DLL which exports stdcall
4525 functions but without the usual @samp{@@<number>} symbol name suffix.
4527 This does not change the naming of symbols provided by the import library
4528 to programs linked against it, but only the entries in the import table
4529 (ie the .idata section).
4532 @itemx --add-stdcall-alias
4533 Specifies that when @command{dlltool} is creating the exports file it
4534 should add aliases for stdcall symbols without @samp{@@ <number>}
4535 in addition to the symbols with @samp{@@ <number>}.
4538 @itemx --ext-prefix-alias @var{prefix}
4539 Causes @command{dlltool} to create external aliases for all DLL
4540 imports with the specified prefix. The aliases are created for both
4541 external and import symbols with no leading underscore.
4545 Specifies that when @command{dlltool} is creating the exports and library
4546 files it should omit the @code{.idata4} section. This is for compatibility
4547 with certain operating systems.
4549 @item --use-nul-prefixed-import-tables
4550 Specifies that when @command{dlltool} is creating the exports and library
4551 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4552 element. This emulates old gnu import library generation of
4553 @code{dlltool}. By default this option is turned off.
4557 Specifies that when @command{dlltool} is creating the exports and library
4558 files it should omit the @code{.idata5} section. This is for compatibility
4559 with certain operating systems.
4561 @item -I @var{filename}
4562 @itemx --identify @var{filename}
4563 Specifies that @command{dlltool} should inspect the import library
4564 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4565 of the associated DLL(s). This can be performed in addition to any
4566 other operations indicated by the other options and arguments.
4567 @command{dlltool} fails if the import library does not exist or is not
4568 actually an import library. See also @option{--identify-strict}.
4570 @item --identify-strict
4571 Modifies the behavior of the @option{--identify} option, such
4572 that an error is reported if @var{filename} is associated with
4577 Specifies that @command{dlltool} should mark the objects in the library
4578 file and exports file that it produces as supporting interworking
4579 between ARM and Thumb code.
4583 Makes @command{dlltool} preserve the temporary assembler files it used to
4584 create the exports file. If this option is repeated then dlltool will
4585 also preserve the temporary object files it uses to create the library
4588 @item -t @var{prefix}
4589 @itemx --temp-prefix @var{prefix}
4590 Makes @command{dlltool} use @var{prefix} when constructing the names of
4591 temporary assembler and object files. By default, the temp file prefix
4592 is generated from the pid.
4596 Make dlltool describe what it is doing.
4600 Displays a list of command-line options and then exits.
4604 Displays dlltool's version number and then exits.
4611 * def file format:: The format of the dlltool @file{.def} file
4614 @node def file format
4615 @section The format of the @command{dlltool} @file{.def} file
4617 A @file{.def} file contains any number of the following commands:
4621 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4622 The result is going to be named @var{name}@code{.exe}.
4624 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4625 The result is going to be named @var{name}@code{.dll}.
4626 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4627 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4630 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4631 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4632 Declares @var{name1} as an exported symbol from the DLL, with optional
4633 ordinal number @var{integer}, or declares @var{name1} as an alias
4634 (forward) of the function @var{external-name} in the DLL.
4635 If @var{its_name} is specified, this name is used as string in export table.
4637 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4638 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4639 If you want to use LIBRARY as name then you need to quote it.
4641 @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{]} *}
4642 Declares that @var{external-name} or the exported function whose
4643 ordinal number is @var{integer} is to be imported from the file
4644 @var{module-name}. If @var{internal-name} is specified then this is
4645 the name that the imported function will be referred to in the body of
4647 If @var{its_name} is specified, this name is used as string in import table.
4648 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4649 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4650 If you want to use LIBRARY as name then you need to quote it.
4652 @item @code{DESCRIPTION} @var{string}
4653 Puts @var{string} into the output @file{.exp} file in the
4654 @code{.rdata} section.
4656 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4657 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4658 Generates @code{--stack} or @code{--heap}
4659 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4660 section. The linker will see this and act upon it.
4662 @item @code{CODE} @var{attr} @code{+}
4663 @item @code{DATA} @var{attr} @code{+}
4664 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4665 Generates @code{--attr} @var{section-name} @var{attr} in the output
4666 @code{.drectve} section, where @var{attr} is one of @code{READ},
4667 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4668 this and act upon it.
4673 @c man begin SEEALSO dlltool
4674 The Info pages for @file{binutils}.
4681 @cindex ELF file information
4684 @c man title readelf display information about ELF files
4687 @c man begin SYNOPSIS readelf
4688 readelf [@option{-a}|@option{--all}]
4689 [@option{-h}|@option{--file-header}]
4690 [@option{-l}|@option{--program-headers}|@option{--segments}]
4691 [@option{-S}|@option{--section-headers}|@option{--sections}]
4692 [@option{-g}|@option{--section-groups}]
4693 [@option{-t}|@option{--section-details}]
4694 [@option{-e}|@option{--headers}]
4695 [@option{-s}|@option{--syms}|@option{--symbols}]
4696 [@option{--dyn-syms}]
4697 [@option{-n}|@option{--notes}]
4698 [@option{-r}|@option{--relocs}]
4699 [@option{-u}|@option{--unwind}]
4700 [@option{-d}|@option{--dynamic}]
4701 [@option{-V}|@option{--version-info}]
4702 [@option{-A}|@option{--arch-specific}]
4703 [@option{-D}|@option{--use-dynamic}]
4704 [@option{-L}|@option{--lint}|@option{--enable-checks}]
4705 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4706 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4707 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4708 [@option{-z}|@option{--decompress}]
4709 [@option{-c}|@option{--archive-index}]
4710 [@option{-w[lLiaprmfFsoORtUuTgAckK]}|
4711 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
4712 [@option{--dwarf-depth=@var{n}}]
4713 [@option{--dwarf-start=@var{n}}]
4714 [@option{--ctf=}@var{section}]
4715 [@option{--ctf-parent=}@var{section}]
4716 [@option{--ctf-symbols=}@var{section}]
4717 [@option{--ctf-strings=}@var{section}]
4718 [@option{-I}|@option{--histogram}]
4719 [@option{-v}|@option{--version}]
4720 [@option{-W}|@option{--wide}]
4721 [@option{-T}|@option{--silent-truncation}]
4722 [@option{-H}|@option{--help}]
4723 @var{elffile}@dots{}
4727 @c man begin DESCRIPTION readelf
4729 @command{readelf} displays information about one or more ELF format object
4730 files. The options control what particular information to display.
4732 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4733 64-bit ELF files are supported, as are archives containing ELF files.
4735 This program performs a similar function to @command{objdump} but it
4736 goes into more detail and it exists independently of the @sc{bfd}
4737 library, so if there is a bug in @sc{bfd} then readelf will not be
4742 @c man begin OPTIONS readelf
4744 The long and short forms of options, shown here as alternatives, are
4745 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4751 Equivalent to specifying @option{--file-header},
4752 @option{--program-headers}, @option{--sections}, @option{--symbols},
4753 @option{--relocs}, @option{--dynamic}, @option{--notes},
4754 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
4755 @option{--section-groups} and @option{--histogram}.
4757 Note - this option does not enable @option{--use-dynamic} itself, so
4758 if that option is not present on the command line then dynamic symbols
4759 and dynamic relocs will not be displayed.
4762 @itemx --file-header
4763 @cindex ELF file header information
4764 Displays the information contained in the ELF header at the start of the
4768 @itemx --program-headers
4770 @cindex ELF program header information
4771 @cindex ELF segment information
4772 Displays the information contained in the file's segment headers, if it
4777 @itemx --section-headers
4778 @cindex ELF section information
4779 Displays the information contained in the file's section headers, if it
4783 @itemx --section-groups
4784 @cindex ELF section group information
4785 Displays the information contained in the file's section groups, if it
4789 @itemx --section-details
4790 @cindex ELF section information
4791 Displays the detailed section information. Implies @option{-S}.
4796 @cindex ELF symbol table information
4797 Displays the entries in symbol table section of the file, if it has one.
4798 If a symbol has version information associated with it then this is
4799 displayed as well. The version string is displayed as a suffix to the
4800 symbol name, preceded by an @@ character. For example
4801 @samp{foo@@VER_1}. If the version is the default version to be used
4802 when resolving unversioned references to the symbol then it is
4803 displayed as a suffix preceded by two @@ characters. For example
4804 @samp{foo@@@@VER_2}.
4807 @cindex ELF dynamic symbol table information
4808 Displays the entries in dynamic symbol table section of the file, if it
4809 has one. The output format is the same as the format used by the
4810 @option{--syms} option.
4814 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4819 Displays the contents of the NOTE segments and/or sections, if any.
4823 @cindex ELF reloc information
4824 Displays the contents of the file's relocation section, if it has one.
4828 @cindex unwind information
4829 Displays the contents of the file's unwind section, if it has one. Only
4830 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4831 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. If
4832 support is not yet implemented for your architecture you could try
4833 dumping the contents of the @var{.eh_frames} section using the
4834 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
4839 @cindex ELF dynamic section information
4840 Displays the contents of the file's dynamic section, if it has one.
4843 @itemx --version-info
4844 @cindex ELF version sections information
4845 Displays the contents of the version sections in the file, it they
4849 @itemx --arch-specific
4850 Displays architecture-specific information in the file, if there
4854 @itemx --use-dynamic
4855 When displaying symbols, this option makes @command{readelf} use the
4856 symbol hash tables in the file's dynamic section, rather than the
4857 symbol table sections.
4859 When displaying relocations, this option makes @command{readelf}
4860 display the dynamic relocations rather than the static relocations.
4864 @itemx --enable-checks
4865 Displays warning messages about possible problems with the file(s)
4866 being examined. If used on its own then all of the contents of the
4867 file(s) will be examined. If used with one of the dumping options
4868 then the warning messages will only be produced for the things being
4871 @item -x <number or name>
4872 @itemx --hex-dump=<number or name>
4873 Displays the contents of the indicated section as a hexadecimal bytes.
4874 A number identifies a particular section by index in the section table;
4875 any other string identifies all sections with that name in the object file.
4877 @item -R <number or name>
4878 @itemx --relocated-dump=<number or name>
4879 Displays the contents of the indicated section as a hexadecimal
4880 bytes. A number identifies a particular section by index in the
4881 section table; any other string identifies all sections with that name
4882 in the object file. The contents of the section will be relocated
4883 before they are displayed.
4885 @item -p <number or name>
4886 @itemx --string-dump=<number or name>
4887 Displays the contents of the indicated section as printable strings.
4888 A number identifies a particular section by index in the section table;
4889 any other string identifies all sections with that name in the object file.
4893 Requests that the section(s) being dumped by @option{x}, @option{R} or
4894 @option{p} options are decompressed before being displayed. If the
4895 section(s) are not compressed then they are displayed as is.
4898 @itemx --archive-index
4899 @cindex Archive file symbol index information
4900 Displays the file symbol index information contained in the header part
4901 of binary archives. Performs the same function as the @option{t}
4902 command to @command{ar}, but without using the BFD library. @xref{ar}.
4904 @item -w[lLiaprmfFsOoRtUuTgAckK]
4905 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
4906 @include debug.options.texi
4908 @include ctf.options.texi
4909 @item --ctf-symbols=@var{section}
4910 @item --ctf-strings=@var{section}
4911 Specify the name of another section from which the CTF file can inherit
4912 strings and symbols. By default, the @code{.symtab} and its linked
4913 string table are used.
4915 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
4916 other must be specified as well.
4920 Display a histogram of bucket list lengths when displaying the contents
4921 of the symbol tables.
4925 Display the version number of readelf.
4929 Don't break output lines to fit into 80 columns. By default
4930 @command{readelf} breaks section header and segment listing lines for
4931 64-bit ELF files, so that they fit into 80 columns. This option causes
4932 @command{readelf} to print each section header resp. each segment one a
4933 single line, which is far more readable on terminals wider than 80 columns.
4936 @itemx --silent-truncation
4937 Normally when readelf is displaying a symbol name, and it has to
4938 truncate the name to fit into an 80 column display, it will add a
4939 suffix of @code{[...]} to the name. This command line option
4940 disables this behaviour, allowing 5 more characters of the name to be
4941 displayed and restoring the old behaviour of readelf (prior to release
4946 Display the command-line options understood by @command{readelf}.
4953 @c man begin SEEALSO readelf
4954 objdump(1), and the Info entries for @file{binutils}.
4961 @cindex Update ELF header
4964 @c man title elfedit update ELF header and program property of ELF files
4967 @c man begin SYNOPSIS elfedit
4968 elfedit [@option{--input-mach=}@var{machine}]
4969 [@option{--input-type=}@var{type}]
4970 [@option{--input-osabi=}@var{osabi}]
4971 @option{--output-mach=}@var{machine}
4972 @option{--output-type=}@var{type}
4973 @option{--output-osabi=}@var{osabi}
4974 @option{--enable-x86-feature=}@var{feature}
4975 @option{--disable-x86-feature=}@var{feature}
4976 [@option{-v}|@option{--version}]
4977 [@option{-h}|@option{--help}]
4978 @var{elffile}@dots{}
4982 @c man begin DESCRIPTION elfedit
4984 @command{elfedit} updates the ELF header and program property of ELF
4985 files which have the matching ELF machine and file types. The options
4986 control how and which fields in the ELF header and program property
4989 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4990 64-bit ELF files are supported, as are archives containing ELF files.
4993 @c man begin OPTIONS elfedit
4995 The long and short forms of options, shown here as alternatives, are
4996 equivalent. At least one of the @option{--output-mach},
4997 @option{--output-type}, @option{--output-osabi},
4998 @option{--enable-x86-feature} and @option{--disable-x86-feature}
4999 options must be given.
5003 @item --input-mach=@var{machine}
5004 Set the matching input ELF machine type to @var{machine}. If
5005 @option{--input-mach} isn't specified, it will match any ELF
5008 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
5009 @var{K1OM} and @var{x86-64}.
5011 @item --output-mach=@var{machine}
5012 Change the ELF machine type in the ELF header to @var{machine}. The
5013 supported ELF machine types are the same as @option{--input-mach}.
5015 @item --input-type=@var{type}
5016 Set the matching input ELF file type to @var{type}. If
5017 @option{--input-type} isn't specified, it will match any ELF file types.
5019 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
5021 @item --output-type=@var{type}
5022 Change the ELF file type in the ELF header to @var{type}. The
5023 supported ELF types are the same as @option{--input-type}.
5025 @item --input-osabi=@var{osabi}
5026 Set the matching input ELF file OSABI to @var{osabi}. If
5027 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
5029 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
5030 @var{GNU}, @var{Linux} (alias for @var{GNU}),
5031 @var{Solaris}, @var{AIX}, @var{Irix},
5032 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
5033 @var{NSK}, @var{AROS} and @var{FenixOS}.
5035 @item --output-osabi=@var{osabi}
5036 Change the ELF OSABI in the ELF header to @var{osabi}. The
5037 supported ELF OSABI are the same as @option{--input-osabi}.
5039 @item --enable-x86-feature=@var{feature}
5040 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
5041 ELF files with machine types of @var{i386} or @var{x86-64}. The
5042 supported features are, @var{ibt} and @var{shstk}.
5044 @item --disable-x86-feature=@var{feature}
5045 Clear the @var{feature} bit in program property in @var{exec} or
5046 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
5047 The supported features are the same as @option{--enable-x86-feature}.
5049 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
5050 are available only on hosts with @samp{mmap} support.
5054 Display the version number of @command{elfedit}.
5058 Display the command-line options understood by @command{elfedit}.
5065 @c man begin SEEALSO elfedit
5066 readelf(1), and the Info entries for @file{binutils}.
5070 @node Common Options
5071 @chapter Common Options
5073 The following command-line options are supported by all of the
5074 programs described in this manual.
5076 @c man begin OPTIONS
5078 @include at-file.texi
5082 Display the command-line options supported by the program.
5085 Display the version number of the program.
5087 @c man begin OPTIONS
5091 @node Selecting the Target System
5092 @chapter Selecting the Target System
5094 You can specify two aspects of the target system to the @sc{gnu}
5095 binary file utilities, each in several ways:
5105 In the following summaries, the lists of ways to specify values are in
5106 order of decreasing precedence. The ways listed first override those
5109 The commands to list valid values only list the values for which the
5110 programs you are running were configured. If they were configured with
5111 @option{--enable-targets=all}, the commands list most of the available
5112 values, but a few are left out; not all targets can be configured in at
5113 once because some of them can only be configured @dfn{native} (on hosts
5114 with the same type as the target system).
5117 * Target Selection::
5118 * Architecture Selection::
5121 @node Target Selection
5122 @section Target Selection
5124 A @dfn{target} is an object file format. A given target may be
5125 supported for multiple architectures (@pxref{Architecture Selection}).
5126 A target selection may also have variations for different operating
5127 systems or architectures.
5129 The command to list valid target values is @samp{objdump -i}
5130 (the first column of output contains the relevant information).
5132 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5133 @samp{a.out-sunos-big}.
5135 You can also specify a target using a configuration triplet. This is
5136 the same sort of name that is passed to @file{configure} to specify a
5137 target. When you use a configuration triplet as an argument, it must be
5138 fully canonicalized. You can see the canonical version of a triplet by
5139 running the shell script @file{config.sub} which is included with the
5142 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5143 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5145 @subheading @command{objdump} Target
5151 command-line option: @option{-b} or @option{--target}
5154 environment variable @code{GNUTARGET}
5157 deduced from the input file
5160 @subheading @command{objcopy} and @command{strip} Input Target
5166 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5169 environment variable @code{GNUTARGET}
5172 deduced from the input file
5175 @subheading @command{objcopy} and @command{strip} Output Target
5181 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5184 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5187 environment variable @code{GNUTARGET}
5190 deduced from the input file
5193 @subheading @command{nm}, @command{size}, and @command{strings} Target
5199 command-line option: @option{--target}
5202 environment variable @code{GNUTARGET}
5205 deduced from the input file
5208 @node Architecture Selection
5209 @section Architecture Selection
5211 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5212 to run. Its name may contain a colon, separating the name of the
5213 processor family from the name of the particular @sc{cpu}.
5215 The command to list valid architecture values is @samp{objdump -i} (the
5216 second column contains the relevant information).
5218 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5220 @subheading @command{objdump} Architecture
5226 command-line option: @option{-m} or @option{--architecture}
5229 deduced from the input file
5232 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5238 deduced from the input file
5243 @cindex separate debug files
5245 debuginfod is a web service that indexes ELF/DWARF debugging resources
5246 by build-id and serves them over HTTP.
5248 Binutils can be built with the debuginfod client library
5249 @code{libdebuginfod} using the @option{--with-debuginfod} configure option.
5250 This option is enabled by default if @code{libdebuginfod} is installed
5251 and found at configure time. This allows @command{objdump} and
5252 @command{readelf} to automatically query debuginfod servers for
5253 separate debug files when the files are otherwise not found.
5255 debuginfod is packaged with elfutils, starting with version 0.178.
5256 You can get the latest version from `https://sourceware.org/elfutils/'.
5258 @node Reporting Bugs
5259 @chapter Reporting Bugs
5261 @cindex reporting bugs
5263 Your bug reports play an essential role in making the binary utilities
5266 Reporting a bug may help you by bringing a solution to your problem, or
5267 it may not. But in any case the principal function of a bug report is
5268 to help the entire community by making the next version of the binary
5269 utilities work better. Bug reports are your contribution to their
5272 In order for a bug report to serve its purpose, you must include the
5273 information that enables us to fix the bug.
5276 * Bug Criteria:: Have you found a bug?
5277 * Bug Reporting:: How to report bugs
5281 @section Have You Found a Bug?
5282 @cindex bug criteria
5284 If you are not sure whether you have found a bug, here are some guidelines:
5287 @cindex fatal signal
5290 If a binary utility gets a fatal signal, for any input whatever, that is
5291 a bug. Reliable utilities never crash.
5293 @cindex error on valid input
5295 If a binary utility produces an error message for valid input, that is a
5299 If you are an experienced user of binary utilities, your suggestions for
5300 improvement are welcome in any case.
5304 @section How to Report Bugs
5306 @cindex bugs, reporting
5308 A number of companies and individuals offer support for @sc{gnu}
5309 products. If you obtained the binary utilities from a support
5310 organization, we recommend you contact that organization first.
5312 You can find contact information for many support companies and
5313 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5317 In any event, we also recommend that you send bug reports for the binary
5318 utilities to @value{BUGURL}.
5321 The fundamental principle of reporting bugs usefully is this:
5322 @strong{report all the facts}. If you are not sure whether to state a
5323 fact or leave it out, state it!
5325 Often people omit facts because they think they know what causes the
5326 problem and assume that some details do not matter. Thus, you might
5327 assume that the name of a file you use in an example does not matter.
5328 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5329 a stray memory reference which happens to fetch from the location where
5330 that pathname is stored in memory; perhaps, if the pathname were
5331 different, the contents of that location would fool the utility into
5332 doing the right thing despite the bug. Play it safe and give a
5333 specific, complete example. That is the easiest thing for you to do,
5334 and the most helpful.
5336 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5337 it is new to us. Therefore, always write your bug reports on the assumption
5338 that the bug has not been reported previously.
5340 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5341 bell?'' This cannot help us fix a bug, so it is basically useless. We
5342 respond by asking for enough details to enable us to investigate.
5343 You might as well expedite matters by sending them to begin with.
5345 To enable us to fix the bug, you should include all these things:
5349 The version of the utility. Each utility announces it if you start it
5350 with the @option{--version} argument.
5352 Without this, we will not know whether there is any point in looking for
5353 the bug in the current version of the binary utilities.
5356 Any patches you may have applied to the source, including any patches
5357 made to the @code{BFD} library.
5360 The type of machine you are using, and the operating system name and
5364 What compiler (and its version) was used to compile the utilities---e.g.
5368 The command arguments you gave the utility to observe the bug. To
5369 guarantee you will not omit something important, list them all. A copy
5370 of the Makefile (or the output from make) is sufficient.
5372 If we were to try to guess the arguments, we would probably guess wrong
5373 and then we might not encounter the bug.
5376 A complete input file, or set of input files, that will reproduce the
5377 bug. If the utility is reading an object file or files, then it is
5378 generally most helpful to send the actual object files.
5380 If the source files were produced exclusively using @sc{gnu} programs
5381 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5382 may be OK to send the source files rather than the object files. In
5383 this case, be sure to say exactly what version of @command{gcc}, or
5384 whatever, was used to produce the object files. Also say how
5385 @command{gcc}, or whatever, was configured.
5388 A description of what behavior you observe that you believe is
5389 incorrect. For example, ``It gets a fatal signal.''
5391 Of course, if the bug is that the utility gets a fatal signal, then we
5392 will certainly notice it. But if the bug is incorrect output, we might
5393 not notice unless it is glaringly wrong. You might as well not give us
5394 a chance to make a mistake.
5396 Even if the problem you experience is a fatal signal, you should still
5397 say so explicitly. Suppose something strange is going on, such as your
5398 copy of the utility is out of sync, or you have encountered a bug in
5399 the C library on your system. (This has happened!) Your copy might
5400 crash and ours would not. If you told us to expect a crash, then when
5401 ours fails to crash, we would know that the bug was not happening for
5402 us. If you had not told us to expect a crash, then we would not be able
5403 to draw any conclusion from our observations.
5406 If you wish to suggest changes to the source, send us context diffs, as
5407 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5408 option. Always send diffs from the old file to the new file. If you
5409 wish to discuss something in the @command{ld} source, refer to it by
5410 context, not by line number.
5412 The line numbers in our development sources will not match those in your
5413 sources. Your line numbers would convey no useful information to us.
5416 Here are some things that are not necessary:
5420 A description of the envelope of the bug.
5422 Often people who encounter a bug spend a lot of time investigating
5423 which changes to the input file will make the bug go away and which
5424 changes will not affect it.
5426 This is often time consuming and not very useful, because the way we
5427 will find the bug is by running a single example under the debugger
5428 with breakpoints, not by pure deduction from a series of examples.
5429 We recommend that you save your time for something else.
5431 Of course, if you can find a simpler example to report @emph{instead}
5432 of the original one, that is a convenience for us. Errors in the
5433 output will be easier to spot, running under the debugger will take
5434 less time, and so on.
5436 However, simplification is not vital; if you do not want to do this,
5437 report the bug anyway and send us the entire test case you used.
5440 A patch for the bug.
5442 A patch for the bug does help us if it is a good one. But do not omit
5443 the necessary information, such as the test case, on the assumption that
5444 a patch is all we need. We might see problems with your patch and decide
5445 to fix the problem another way, or we might not understand it at all.
5447 Sometimes with programs as complicated as the binary utilities it is
5448 very hard to construct an example that will make the program follow a
5449 certain path through the code. If you do not send us the example, we
5450 will not be able to construct one, so we will not be able to verify that
5453 And if we cannot understand what bug you are trying to fix, or why your
5454 patch should be an improvement, we will not install it. A test case will
5455 help us to understand.
5458 A guess about what the bug is or what it depends on.
5460 Such guesses are usually wrong. Even we cannot guess right about such
5461 things without first using the debugger to find the facts.
5464 @node GNU Free Documentation License
5465 @appendix GNU Free Documentation License
5469 @node Binutils Index
5470 @unnumbered Binutils Index