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{--with-symbol-versions}] [@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 --with-symbol-versions
1134 Enables the display of symbol version information if any exists. The
1135 version string is displayed as a suffix to the symbol name, preceeded by
1136 an @@ character. For example @samp{foo@@VER_1}. If the version is
1137 the default version to be used when resolving unversioned references
1138 to the symbol then it is displayed as a suffix preceeded by two @@
1139 characters. For example @samp{foo@@@@VER_2}.
1141 @item --target=@var{bfdname}
1142 @cindex object code format
1143 Specify an object code format other than your system's default format.
1144 @xref{Target Selection}, for more information.
1151 @c man begin SEEALSO nm
1152 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1159 @c man title objcopy copy and translate object files
1162 @c man begin SYNOPSIS objcopy
1163 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1164 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1165 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1166 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1167 [@option{-S}|@option{--strip-all}]
1168 [@option{-g}|@option{--strip-debug}]
1169 [@option{--strip-unneeded}]
1170 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1171 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1172 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1173 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1174 [@option{--localize-hidden}]
1175 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1176 [@option{--globalize-symbol=}@var{symbolname}]
1177 [@option{--globalize-symbols=}@var{filename}]
1178 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1179 [@option{-w}|@option{--wildcard}]
1180 [@option{-x}|@option{--discard-all}]
1181 [@option{-X}|@option{--discard-locals}]
1182 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1183 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1184 [@option{--interleave-width=}@var{width}]
1185 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1186 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1187 [@option{--keep-section=}@var{sectionpattern}]
1188 [@option{--remove-relocations=}@var{sectionpattern}]
1189 [@option{-p}|@option{--preserve-dates}]
1190 [@option{-D}|@option{--enable-deterministic-archives}]
1191 [@option{-U}|@option{--disable-deterministic-archives}]
1192 [@option{--debugging}]
1193 [@option{--gap-fill=}@var{val}]
1194 [@option{--pad-to=}@var{address}]
1195 [@option{--set-start=}@var{val}]
1196 [@option{--adjust-start=}@var{incr}]
1197 [@option{--change-addresses=}@var{incr}]
1198 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1199 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1200 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1201 [@option{--change-warnings}] [@option{--no-change-warnings}]
1202 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1203 [@option{--set-section-alignment} @var{sectionpattern}=@var{align}]
1204 [@option{--add-section} @var{sectionname}=@var{filename}]
1205 [@option{--dump-section} @var{sectionname}=@var{filename}]
1206 [@option{--update-section} @var{sectionname}=@var{filename}]
1207 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1208 [@option{--long-section-names} @{enable,disable,keep@}]
1209 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1210 [@option{--reverse-bytes=}@var{num}]
1211 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1212 [@option{--redefine-sym} @var{old}=@var{new}]
1213 [@option{--redefine-syms=}@var{filename}]
1215 [@option{--keep-symbols=}@var{filename}]
1216 [@option{--strip-symbols=}@var{filename}]
1217 [@option{--strip-unneeded-symbols=}@var{filename}]
1218 [@option{--keep-global-symbols=}@var{filename}]
1219 [@option{--localize-symbols=}@var{filename}]
1220 [@option{--weaken-symbols=}@var{filename}]
1221 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]]
1222 [@option{--alt-machine-code=}@var{index}]
1223 [@option{--prefix-symbols=}@var{string}]
1224 [@option{--prefix-sections=}@var{string}]
1225 [@option{--prefix-alloc-sections=}@var{string}]
1226 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1227 [@option{--keep-file-symbols}]
1228 [@option{--only-keep-debug}]
1229 [@option{--strip-dwo}]
1230 [@option{--extract-dwo}]
1231 [@option{--extract-symbol}]
1232 [@option{--writable-text}]
1233 [@option{--readonly-text}]
1236 [@option{--file-alignment=}@var{num}]
1237 [@option{--heap=}@var{size}]
1238 [@option{--image-base=}@var{address}]
1239 [@option{--section-alignment=}@var{num}]
1240 [@option{--stack=}@var{size}]
1241 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1242 [@option{--compress-debug-sections}]
1243 [@option{--decompress-debug-sections}]
1244 [@option{--elf-stt-common=@var{val}}]
1245 [@option{--merge-notes}]
1246 [@option{--no-merge-notes}]
1247 [@option{--verilog-data-width=@var{val}}]
1248 [@option{-v}|@option{--verbose}]
1249 [@option{-V}|@option{--version}]
1250 [@option{--help}] [@option{--info}]
1251 @var{infile} [@var{outfile}]
1255 @c man begin DESCRIPTION objcopy
1256 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1257 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1258 read and write the object files. It can write the destination object
1259 file in a format different from that of the source object file. The
1260 exact behavior of @command{objcopy} is controlled by command-line options.
1261 Note that @command{objcopy} should be able to copy a fully linked file
1262 between any two formats. However, copying a relocatable object file
1263 between any two formats may not work as expected.
1265 @command{objcopy} creates temporary files to do its translations and
1266 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1267 translation work; it has access to all the formats described in @sc{bfd}
1268 and thus is able to recognize most formats without being told
1269 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1271 @command{objcopy} can be used to generate S-records by using an output
1272 target of @samp{srec} (e.g., use @samp{-O srec}).
1274 @command{objcopy} can be used to generate a raw binary file by using an
1275 output target of @samp{binary} (e.g., use @option{-O binary}). When
1276 @command{objcopy} generates a raw binary file, it will essentially produce
1277 a memory dump of the contents of the input object file. All symbols and
1278 relocation information will be discarded. The memory dump will start at
1279 the load address of the lowest section copied into the output file.
1281 When generating an S-record or a raw binary file, it may be helpful to
1282 use @option{-S} to remove sections containing debugging information. In
1283 some cases @option{-R} will be useful to remove sections which contain
1284 information that is not needed by the binary file.
1286 Note---@command{objcopy} is not able to change the endianness of its input
1287 files. If the input format has an endianness (some formats do not),
1288 @command{objcopy} can only copy the inputs into file formats that have the
1289 same endianness or which have no endianness (e.g., @samp{srec}).
1290 (However, see the @option{--reverse-bytes} option.)
1294 @c man begin OPTIONS objcopy
1298 @itemx @var{outfile}
1299 The input and output files, respectively.
1300 If you do not specify @var{outfile}, @command{objcopy} creates a
1301 temporary file and destructively renames the result with
1302 the name of @var{infile}.
1304 @item -I @var{bfdname}
1305 @itemx --input-target=@var{bfdname}
1306 Consider the source file's object format to be @var{bfdname}, rather than
1307 attempting to deduce it. @xref{Target Selection}, for more information.
1309 @item -O @var{bfdname}
1310 @itemx --output-target=@var{bfdname}
1311 Write the output file using the object format @var{bfdname}.
1312 @xref{Target Selection}, for more information.
1314 @item -F @var{bfdname}
1315 @itemx --target=@var{bfdname}
1316 Use @var{bfdname} as the object format for both the input and the output
1317 file; i.e., simply transfer data from source to destination with no
1318 translation. @xref{Target Selection}, for more information.
1320 @item -B @var{bfdarch}
1321 @itemx --binary-architecture=@var{bfdarch}
1322 Useful when transforming a architecture-less input file into an object file.
1323 In this case the output architecture can be set to @var{bfdarch}. This
1324 option will be ignored if the input file has a known @var{bfdarch}. You
1325 can access this binary data inside a program by referencing the special
1326 symbols that are created by the conversion process. These symbols are
1327 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1328 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1329 an object file and then access it in your code using these symbols.
1331 @item -j @var{sectionpattern}
1332 @itemx --only-section=@var{sectionpattern}
1333 Copy only the indicated sections from the input file to the output file.
1334 This option may be given more than once. Note that using this option
1335 inappropriately may make the output file unusable. Wildcard
1336 characters are accepted in @var{sectionpattern}.
1338 If the first character of @var{sectionpattern} is the exclamation
1339 point (!) then matching sections will not be copied, even if earlier
1340 use of @option{--only-section} on the same command line would
1341 otherwise copy it. For example:
1344 --only-section=.text.* --only-section=!.text.foo
1347 will copy all sectinos maching '.text.*' but not the section
1350 @item -R @var{sectionpattern}
1351 @itemx --remove-section=@var{sectionpattern}
1352 Remove any section matching @var{sectionpattern} from the output file.
1353 This option may be given more than once. Note that using this option
1354 inappropriately may make the output file unusable. Wildcard
1355 characters are accepted in @var{sectionpattern}. Using both the
1356 @option{-j} and @option{-R} options together results in undefined
1359 If the first character of @var{sectionpattern} is the exclamation
1360 point (!) then matching sections will not be removed even if an
1361 earlier use of @option{--remove-section} on the same command line
1362 would otherwise remove it. For example:
1365 --remove-section=.text.* --remove-section=!.text.foo
1368 will remove all sections matching the pattern '.text.*', but will not
1369 remove the section '.text.foo'.
1371 @item --keep-section=@var{sectionpattern}
1372 When removing sections from the output file, keep sections that match
1373 @var{sectionpattern}.
1375 @item --remove-relocations=@var{sectionpattern}
1376 Remove non-dynamic relocations from the output file for any section
1377 matching @var{sectionpattern}. This option may be given more than
1378 once. Note that using this option inappropriately may make the output
1379 file unusable, and attempting to remove a dynamic relocation section
1380 such as @samp{.rela.plt} from an executable or shared library with
1381 @option{--remove-relocations=.plt} will not work. Wildcard characters
1382 are accepted in @var{sectionpattern}.
1386 --remove-relocations=.text.*
1389 will remove the relocations for all sections matching the pattern
1392 If the first character of @var{sectionpattern} is the exclamation
1393 point (!) then matching sections will not have their relocation
1394 removed even if an earlier use of @option{--remove-relocations} on the
1395 same command line would otherwise cause the relocations to be removed.
1399 --remove-relocations=.text.* --remove-relocations=!.text.foo
1402 will remove all relocations for sections matching the pattern
1403 '.text.*', but will not remove relocations for the section
1408 Do not copy relocation and symbol information from the source file.
1411 @itemx --strip-debug
1412 Do not copy debugging symbols or sections from the source file.
1414 @item --strip-unneeded
1415 Strip all symbols that are not needed for relocation processing.
1417 @item -K @var{symbolname}
1418 @itemx --keep-symbol=@var{symbolname}
1419 When stripping symbols, keep symbol @var{symbolname} even if it would
1420 normally be stripped. This option may be given more than once.
1422 @item -N @var{symbolname}
1423 @itemx --strip-symbol=@var{symbolname}
1424 Do not copy symbol @var{symbolname} from the source file. This option
1425 may be given more than once.
1427 @item --strip-unneeded-symbol=@var{symbolname}
1428 Do not copy symbol @var{symbolname} from the source file unless it is needed
1429 by a relocation. This option may be given more than once.
1431 @item -G @var{symbolname}
1432 @itemx --keep-global-symbol=@var{symbolname}
1433 Keep only symbol @var{symbolname} global. Make all other symbols local
1434 to the file, so that they are not visible externally. This option may
1435 be given more than once. Note: this option cannot be used in
1436 conjunction with the @option{--globalize-symbol} or
1437 @option{--globalize-symbols} options.
1439 @item --localize-hidden
1440 In an ELF object, mark all symbols that have hidden or internal visibility
1441 as local. This option applies on top of symbol-specific localization options
1442 such as @option{-L}.
1444 @item -L @var{symbolname}
1445 @itemx --localize-symbol=@var{symbolname}
1446 Convert a global or weak symbol called @var{symbolname} into a local
1447 symbol, so that it is not visible externally. This option may be
1448 given more than once. Note - unique symbols are not converted.
1450 @item -W @var{symbolname}
1451 @itemx --weaken-symbol=@var{symbolname}
1452 Make symbol @var{symbolname} weak. This option may be given more than once.
1454 @item --globalize-symbol=@var{symbolname}
1455 Give symbol @var{symbolname} global scoping so that it is visible
1456 outside of the file in which it is defined. This option may be given
1457 more than once. Note: this option cannot be used in conjunction with
1458 the @option{-G} or @option{--keep-global-symbol} options.
1462 Permit regular expressions in @var{symbolname}s used in other command
1463 line options. The question mark (?), asterisk (*), backslash (\) and
1464 square brackets ([]) operators can be used anywhere in the symbol
1465 name. If the first character of the symbol name is the exclamation
1466 point (!) then the sense of the switch is reversed for that symbol.
1473 would cause objcopy to weaken all symbols that start with ``fo''
1474 except for the symbol ``foo''.
1477 @itemx --discard-all
1478 Do not copy non-global symbols from the source file.
1479 @c FIXME any reason to prefer "non-global" to "local" here?
1482 @itemx --discard-locals
1483 Do not copy compiler-generated local symbols.
1484 (These usually start with @samp{L} or @samp{.}.)
1487 @itemx --byte=@var{byte}
1488 If interleaving has been enabled via the @option{--interleave} option
1489 then start the range of bytes to keep at the @var{byte}th byte.
1490 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1491 @var{breadth} is the value given by the @option{--interleave} option.
1493 @item -i [@var{breadth}]
1494 @itemx --interleave[=@var{breadth}]
1495 Only copy a range out of every @var{breadth} bytes. (Header data is
1496 not affected). Select which byte in the range begins the copy with
1497 the @option{--byte} option. Select the width of the range with the
1498 @option{--interleave-width} option.
1500 This option is useful for creating files to program @sc{rom}. It is
1501 typically used with an @code{srec} output target. Note that
1502 @command{objcopy} will complain if you do not specify the
1503 @option{--byte} option as well.
1505 The default interleave breadth is 4, so with @option{--byte} set to 0,
1506 @command{objcopy} would copy the first byte out of every four bytes
1507 from the input to the output.
1509 @item --interleave-width=@var{width}
1510 When used with the @option{--interleave} option, copy @var{width}
1511 bytes at a time. The start of the range of bytes to be copied is set
1512 by the @option{--byte} option, and the extent of the range is set with
1513 the @option{--interleave} option.
1515 The default value for this option is 1. The value of @var{width} plus
1516 the @var{byte} value set by the @option{--byte} option must not exceed
1517 the interleave breadth set by the @option{--interleave} option.
1519 This option can be used to create images for two 16-bit flashes interleaved
1520 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1521 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1522 commands. If the input was '12345678' then the outputs would be
1523 '1256' and '3478' respectively.
1526 @itemx --preserve-dates
1527 Set the access and modification dates of the output file to be the same
1528 as those of the input file.
1531 @itemx --enable-deterministic-archives
1532 @cindex deterministic archives
1533 @kindex --enable-deterministic-archives
1534 Operate in @emph{deterministic} mode. When copying archive members
1535 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1536 and use consistent file modes for all files.
1538 If @file{binutils} was configured with
1539 @option{--enable-deterministic-archives}, then this mode is on by default.
1540 It can be disabled with the @samp{-U} option, below.
1543 @itemx --disable-deterministic-archives
1544 @cindex deterministic archives
1545 @kindex --enable-deterministic-archives
1546 Do @emph{not} operate in @emph{deterministic} mode. This is the
1547 inverse of the @option{-D} option, above: when copying archive members
1548 and writing the archive index, use their actual UID, GID, timestamp,
1549 and file mode values.
1551 This is the default unless @file{binutils} was configured with
1552 @option{--enable-deterministic-archives}.
1555 Convert debugging information, if possible. This is not the default
1556 because only certain debugging formats are supported, and the
1557 conversion process can be time consuming.
1559 @item --gap-fill @var{val}
1560 Fill gaps between sections with @var{val}. This operation applies to
1561 the @emph{load address} (LMA) of the sections. It is done by increasing
1562 the size of the section with the lower address, and filling in the extra
1563 space created with @var{val}.
1565 @item --pad-to @var{address}
1566 Pad the output file up to the load address @var{address}. This is
1567 done by increasing the size of the last section. The extra space is
1568 filled in with the value specified by @option{--gap-fill} (default zero).
1570 @item --set-start @var{val}
1571 Set the start address of the new file to @var{val}. Not all object file
1572 formats support setting the start address.
1574 @item --change-start @var{incr}
1575 @itemx --adjust-start @var{incr}
1576 @cindex changing start address
1577 Change the start address by adding @var{incr}. Not all object file
1578 formats support setting the start address.
1580 @item --change-addresses @var{incr}
1581 @itemx --adjust-vma @var{incr}
1582 @cindex changing object addresses
1583 Change the VMA and LMA addresses of all sections, as well as the start
1584 address, by adding @var{incr}. Some object file formats do not permit
1585 section addresses to be changed arbitrarily. Note that this does not
1586 relocate the sections; if the program expects sections to be loaded at a
1587 certain address, and this option is used to change the sections such
1588 that they are loaded at a different address, the program may fail.
1590 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1591 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1592 @cindex changing section address
1593 Set or change both the VMA address and the LMA address of any section
1594 matching @var{sectionpattern}. If @samp{=} is used, the section
1595 address is set to @var{val}. Otherwise, @var{val} is added to or
1596 subtracted from the section address. See the comments under
1597 @option{--change-addresses}, above. If @var{sectionpattern} does not
1598 match any sections in the input file, a warning will be issued, unless
1599 @option{--no-change-warnings} is used.
1601 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1602 @cindex changing section LMA
1603 Set or change the LMA address of any sections matching
1604 @var{sectionpattern}. The LMA address is the address where the
1605 section will be loaded into memory at program load time. Normally
1606 this is the same as the VMA address, which is the address of the
1607 section at program run time, but on some systems, especially those
1608 where a program is held in ROM, the two can be different. If @samp{=}
1609 is used, the section address is set to @var{val}. Otherwise,
1610 @var{val} is added to or subtracted from the section address. See the
1611 comments under @option{--change-addresses}, above. If
1612 @var{sectionpattern} does not match any sections in the input file, a
1613 warning will be issued, unless @option{--no-change-warnings} is used.
1615 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1616 @cindex changing section VMA
1617 Set or change the VMA address of any section matching
1618 @var{sectionpattern}. The VMA address is the address where the
1619 section will be located once the program has started executing.
1620 Normally this is the same as the LMA address, which is the address
1621 where the section will be loaded into memory, but on some systems,
1622 especially those where a program is held in ROM, the two can be
1623 different. If @samp{=} is used, the section address is set to
1624 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1625 section address. See the comments under @option{--change-addresses},
1626 above. If @var{sectionpattern} does not match any sections in the
1627 input file, a warning will be issued, unless
1628 @option{--no-change-warnings} is used.
1630 @item --change-warnings
1631 @itemx --adjust-warnings
1632 If @option{--change-section-address} or @option{--change-section-lma} or
1633 @option{--change-section-vma} is used, and the section pattern does not
1634 match any sections, issue a warning. This is the default.
1636 @item --no-change-warnings
1637 @itemx --no-adjust-warnings
1638 Do not issue a warning if @option{--change-section-address} or
1639 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1640 if the section pattern does not match any sections.
1642 @item --set-section-flags @var{sectionpattern}=@var{flags}
1643 Set the flags for any sections matching @var{sectionpattern}. The
1644 @var{flags} argument is a comma separated string of flag names. The
1645 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1646 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1647 @samp{exclude}, @samp{share}, and @samp{debug}. You can set the
1648 @samp{contents} flag for a section which does not have contents, but it
1649 is not meaningful to clear the @samp{contents} flag of a section which
1650 does have contents--just remove the section instead. Not all flags are
1651 meaningful for all object file formats. In particular the
1652 @samp{share} flag is only meaningful for COFF format files and not for
1655 @item --set-section-alignment @var{sectionpattern}=@var{align}
1656 Set the alignment for any sections matching @var{sectionpattern}.
1657 @var{align} specifies the alignment in bytes and must be a power of
1658 two, i.e. 1, 2, 4, 8@dots{}.
1660 @item --add-section @var{sectionname}=@var{filename}
1661 Add a new section named @var{sectionname} while copying the file. The
1662 contents of the new section are taken from the file @var{filename}. The
1663 size of the section will be the size of the file. This option only
1664 works on file formats which can support sections with arbitrary names.
1665 Note - it may be necessary to use the @option{--set-section-flags}
1666 option to set the attributes of the newly created section.
1668 @item --dump-section @var{sectionname}=@var{filename}
1669 Place the contents of section named @var{sectionname} into the file
1670 @var{filename}, overwriting any contents that may have been there
1671 previously. This option is the inverse of @option{--add-section}.
1672 This option is similar to the @option{--only-section} option except
1673 that it does not create a formatted file, it just dumps the contents
1674 as raw binary data, without applying any relocations. The option can
1675 be specified more than once.
1677 @item --update-section @var{sectionname}=@var{filename}
1678 Replace the existing contents of a section named @var{sectionname}
1679 with the contents of file @var{filename}. The size of the section
1680 will be adjusted to the size of the file. The section flags for
1681 @var{sectionname} will be unchanged. For ELF format files the section
1682 to segment mapping will also remain unchanged, something which is not
1683 possible using @option{--remove-section} followed by
1684 @option{--add-section}. The option can be specified more than once.
1686 Note - it is possible to use @option{--rename-section} and
1687 @option{--update-section} to both update and rename a section from one
1688 command line. In this case, pass the original section name to
1689 @option{--update-section}, and the original and new section names to
1690 @option{--rename-section}.
1692 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1693 Add a new symbol named @var{name} while copying the file. This option may be
1694 specified multiple times. If the @var{section} is given, the symbol will be
1695 associated with and relative to that section, otherwise it will be an ABS
1696 symbol. Specifying an undefined section will result in a fatal error. There
1697 is no check for the value, it will be taken as specified. Symbol flags can
1698 be specified and not all flags will be meaningful for all object file
1699 formats. By default, the symbol will be global. The special flag
1700 'before=@var{othersym}' will insert the new symbol in front of the specified
1701 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1702 symbol table in the order they appear.
1704 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1705 Rename a section from @var{oldname} to @var{newname}, optionally
1706 changing the section's flags to @var{flags} in the process. This has
1707 the advantage over using a linker script to perform the rename in that
1708 the output stays as an object file and does not become a linked
1709 executable. This option accepts the same set of flags as the
1710 @option{--sect-section-flags} option.
1712 This option is particularly helpful when the input format is binary,
1713 since this will always create a section called .data. If for example,
1714 you wanted instead to create a section called .rodata containing binary
1715 data you could use the following command line to achieve it:
1718 objcopy -I binary -O <output_format> -B <architecture> \
1719 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1720 <input_binary_file> <output_object_file>
1723 @item --long-section-names @{enable,disable,keep@}
1724 Controls the handling of long section names when processing @code{COFF}
1725 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1726 is to preserve long section names if any are present in the input file.
1727 The @samp{enable} and @samp{disable} options forcibly enable or disable
1728 the use of long section names in the output object; when @samp{disable}
1729 is in effect, any long section names in the input object will be truncated.
1730 The @samp{enable} option will only emit long section names if any are
1731 present in the inputs; this is mostly the same as @samp{keep}, but it
1732 is left undefined whether the @samp{enable} option might force the
1733 creation of an empty string table in the output file.
1735 @item --change-leading-char
1736 Some object file formats use special characters at the start of
1737 symbols. The most common such character is underscore, which compilers
1738 often add before every symbol. This option tells @command{objcopy} to
1739 change the leading character of every symbol when it converts between
1740 object file formats. If the object file formats use the same leading
1741 character, this option has no effect. Otherwise, it will add a
1742 character, or remove a character, or change a character, as
1745 @item --remove-leading-char
1746 If the first character of a global symbol is a special symbol leading
1747 character used by the object file format, remove the character. The
1748 most common symbol leading character is underscore. This option will
1749 remove a leading underscore from all global symbols. This can be useful
1750 if you want to link together objects of different file formats with
1751 different conventions for symbol names. This is different from
1752 @option{--change-leading-char} because it always changes the symbol name
1753 when appropriate, regardless of the object file format of the output
1756 @item --reverse-bytes=@var{num}
1757 Reverse the bytes in a section with output contents. A section length must
1758 be evenly divisible by the value given in order for the swap to be able to
1759 take place. Reversing takes place before the interleaving is performed.
1761 This option is used typically in generating ROM images for problematic
1762 target systems. For example, on some target boards, the 32-bit words
1763 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1764 regardless of the CPU byte order. Depending on the programming model, the
1765 endianness of the ROM may need to be modified.
1767 Consider a simple file with a section containing the following eight
1768 bytes: @code{12345678}.
1770 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1771 output file would be ordered @code{21436587}.
1773 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1774 output file would be ordered @code{43218765}.
1776 By using @samp{--reverse-bytes=2} for the above example, followed by
1777 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1778 output file would be ordered @code{34127856}.
1780 @item --srec-len=@var{ival}
1781 Meaningful only for srec output. Set the maximum length of the Srecords
1782 being produced to @var{ival}. This length covers both address, data and
1785 @item --srec-forceS3
1786 Meaningful only for srec output. Avoid generation of S1/S2 records,
1787 creating S3-only record format.
1789 @item --redefine-sym @var{old}=@var{new}
1790 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1791 when one is trying link two things together for which you have no
1792 source, and there are name collisions.
1794 @item --redefine-syms=@var{filename}
1795 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1796 listed in the file @var{filename}. @var{filename} is simply a flat file,
1797 with one symbol pair per line. Line comments may be introduced by the hash
1798 character. This option may be given more than once.
1801 Change all global symbols in the file to be weak. This can be useful
1802 when building an object which will be linked against other objects using
1803 the @option{-R} option to the linker. This option is only effective when
1804 using an object file format which supports weak symbols.
1806 @item --keep-symbols=@var{filename}
1807 Apply @option{--keep-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-symbols=@var{filename}
1813 Apply @option{--strip-symbol} option to each symbol listed in the file
1814 @var{filename}. @var{filename} is simply a flat file, with one symbol
1815 name per line. Line comments may be introduced by the hash character.
1816 This option may be given more than once.
1818 @item --strip-unneeded-symbols=@var{filename}
1819 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1820 the 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 --keep-global-symbols=@var{filename}
1825 Apply @option{--keep-global-symbol} option to each symbol listed in the
1826 file @var{filename}. @var{filename} is simply a flat file, with one
1827 symbol name per line. Line comments may be introduced by the hash
1828 character. This option may be given more than once.
1830 @item --localize-symbols=@var{filename}
1831 Apply @option{--localize-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.
1836 @item --globalize-symbols=@var{filename}
1837 Apply @option{--globalize-symbol} option to each symbol listed in the file
1838 @var{filename}. @var{filename} is simply a flat file, with one symbol
1839 name per line. Line comments may be introduced by the hash character.
1840 This option may be given more than once. Note: this option cannot be
1841 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1844 @item --weaken-symbols=@var{filename}
1845 Apply @option{--weaken-symbol} option to each symbol listed in the file
1846 @var{filename}. @var{filename} is simply a flat file, with one symbol
1847 name per line. Line comments may be introduced by the hash character.
1848 This option may be given more than once.
1850 @item --alt-machine-code=@var{index}
1851 If the output architecture has alternate machine codes, use the
1852 @var{index}th code instead of the default one. This is useful in case
1853 a machine is assigned an official code and the tool-chain adopts the
1854 new code, but other applications still depend on the original code
1855 being used. For ELF based architectures if the @var{index}
1856 alternative does not exist then the value is treated as an absolute
1857 number to be stored in the e_machine field of the ELF header.
1859 @item --writable-text
1860 Mark the output text as writable. This option isn't meaningful for all
1861 object file formats.
1863 @item --readonly-text
1864 Make the output text write protected. This option isn't meaningful for all
1865 object file formats.
1868 Mark the output file as demand paged. This option isn't meaningful for all
1869 object file formats.
1872 Mark the output file as impure. This option isn't meaningful for all
1873 object file formats.
1875 @item --prefix-symbols=@var{string}
1876 Prefix all symbols in the output file with @var{string}.
1878 @item --prefix-sections=@var{string}
1879 Prefix all section names in the output file with @var{string}.
1881 @item --prefix-alloc-sections=@var{string}
1882 Prefix all the names of all allocated sections in the output file with
1885 @item --add-gnu-debuglink=@var{path-to-file}
1886 Creates a .gnu_debuglink section which contains a reference to
1887 @var{path-to-file} and adds it to the output file. Note: the file at
1888 @var{path-to-file} must exist. Part of the process of adding the
1889 .gnu_debuglink section involves embedding a checksum of the contents
1890 of the debug info file into the section.
1892 If the debug info file is built in one location but it is going to be
1893 installed at a later time into a different location then do not use
1894 the path to the installed location. The @option{--add-gnu-debuglink}
1895 option will fail because the installed file does not exist yet.
1896 Instead put the debug info file in the current directory and use the
1897 @option{--add-gnu-debuglink} option without any directory components,
1901 objcopy --add-gnu-debuglink=foo.debug
1904 At debug time the debugger will attempt to look for the separate debug
1905 info file in a set of known locations. The exact set of these
1906 locations varies depending upon the distribution being used, but it
1911 @item * The same directory as the executable.
1913 @item * A sub-directory of the directory containing the executable
1916 @item * A global debug directory such as /usr/lib/debug.
1919 As long as the debug info file has been installed into one of these
1920 locations before the debugger is run everything should work
1923 @item --keep-file-symbols
1924 When stripping a file, perhaps with @option{--strip-debug} or
1925 @option{--strip-unneeded}, retain any symbols specifying source file names,
1926 which would otherwise get stripped.
1928 @item --only-keep-debug
1929 Strip a file, removing contents of any sections that would not be
1930 stripped by @option{--strip-debug} and leaving the debugging sections
1931 intact. In ELF files, this preserves all note sections in the output.
1933 Note - the section headers of the stripped sections are preserved,
1934 including their sizes, but the contents of the section are discarded.
1935 The section headers are preserved so that other tools can match up the
1936 debuginfo file with the real executable, even if that executable has
1937 been relocated to a different address space.
1939 The intention is that this option will be used in conjunction with
1940 @option{--add-gnu-debuglink} to create a two part executable. One a
1941 stripped binary which will occupy less space in RAM and in a
1942 distribution and the second a debugging information file which is only
1943 needed if debugging abilities are required. The suggested procedure
1944 to create these files is as follows:
1947 @item Link the executable as normal. Assuming that it is called
1949 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1950 create a file containing the debugging info.
1951 @item Run @code{objcopy --strip-debug foo} to create a
1952 stripped executable.
1953 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1954 to add a link to the debugging info into the stripped executable.
1957 Note---the choice of @code{.dbg} as an extension for the debug info
1958 file is arbitrary. Also the @code{--only-keep-debug} step is
1959 optional. You could instead do this:
1962 @item Link the executable as normal.
1963 @item Copy @code{foo} to @code{foo.full}
1964 @item Run @code{objcopy --strip-debug foo}
1965 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1968 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1969 full executable. It does not have to be a file created by the
1970 @option{--only-keep-debug} switch.
1972 Note---this switch is only intended for use on fully linked files. It
1973 does not make sense to use it on object files where the debugging
1974 information may be incomplete. Besides the gnu_debuglink feature
1975 currently only supports the presence of one filename containing
1976 debugging information, not multiple filenames on a one-per-object-file
1980 Remove the contents of all DWARF .dwo sections, leaving the
1981 remaining debugging sections and all symbols intact.
1982 This option is intended for use by the compiler as part of
1983 the @option{-gsplit-dwarf} option, which splits debug information
1984 between the .o file and a separate .dwo file. The compiler
1985 generates all debug information in the same file, then uses
1986 the @option{--extract-dwo} option to copy the .dwo sections to
1987 the .dwo file, then the @option{--strip-dwo} option to remove
1988 those sections from the original .o file.
1991 Extract the contents of all DWARF .dwo sections. See the
1992 @option{--strip-dwo} option for more information.
1994 @item --file-alignment @var{num}
1995 Specify the file alignment. Sections in the file will always begin at
1996 file offsets which are multiples of this number. This defaults to
1998 [This option is specific to PE targets.]
2000 @item --heap @var{reserve}
2001 @itemx --heap @var{reserve},@var{commit}
2002 Specify the number of bytes of memory to reserve (and optionally commit)
2003 to be used as heap for this program.
2004 [This option is specific to PE targets.]
2006 @item --image-base @var{value}
2007 Use @var{value} as the base address of your program or dll. This is
2008 the lowest memory location that will be used when your program or dll
2009 is loaded. To reduce the need to relocate and improve performance of
2010 your dlls, each should have a unique base address and not overlap any
2011 other dlls. The default is 0x400000 for executables, and 0x10000000
2013 [This option is specific to PE targets.]
2015 @item --section-alignment @var{num}
2016 Sets the section alignment field in the PE header. Sections in memory
2017 will always begin at addresses which are a multiple of this number.
2019 [This option is specific to PE targets.]
2021 @item --stack @var{reserve}
2022 @itemx --stack @var{reserve},@var{commit}
2023 Specify the number of bytes of memory to reserve (and optionally commit)
2024 to be used as stack for this program.
2025 [This option is specific to PE targets.]
2027 @item --subsystem @var{which}
2028 @itemx --subsystem @var{which}:@var{major}
2029 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2030 Specifies the subsystem under which your program will execute. The
2031 legal values for @var{which} are @code{native}, @code{windows},
2032 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
2033 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
2034 the subsystem version also. Numeric values are also accepted for
2036 [This option is specific to PE targets.]
2038 @item --extract-symbol
2039 Keep the file's section flags and symbols but remove all section data.
2040 Specifically, the option:
2043 @item removes the contents of all sections;
2044 @item sets the size of every section to zero; and
2045 @item sets the file's start address to zero.
2048 This option is used to build a @file{.sym} file for a VxWorks kernel.
2049 It can also be a useful way of reducing the size of a @option{--just-symbols}
2052 @item --compress-debug-sections
2053 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2054 ELF ABI. Note - if compression would actually make a section
2055 @emph{larger}, then it is not compressed.
2057 @item --compress-debug-sections=none
2058 @itemx --compress-debug-sections=zlib
2059 @itemx --compress-debug-sections=zlib-gnu
2060 @itemx --compress-debug-sections=zlib-gabi
2061 For ELF files, these options control how DWARF debug sections are
2062 compressed. @option{--compress-debug-sections=none} is equivalent
2063 to @option{--decompress-debug-sections}.
2064 @option{--compress-debug-sections=zlib} and
2065 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2066 @option{--compress-debug-sections}.
2067 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
2068 sections using zlib. The debug sections are renamed to begin with
2069 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
2070 actually make a section @emph{larger}, then it is not compressed nor
2073 @item --decompress-debug-sections
2074 Decompress DWARF debug sections using zlib. The original section
2075 names of the compressed sections are restored.
2077 @item --elf-stt-common=yes
2078 @itemx --elf-stt-common=no
2079 For ELF files, these options control whether common symbols should be
2080 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2081 @option{--elf-stt-common=yes} converts common symbol type to
2082 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2083 type to @code{STT_OBJECT}.
2086 @itemx --no-merge-notes
2087 For ELF files, attempt (or do not attempt) to reduce the size of any
2088 SHT_NOTE type sections by removing duplicate notes.
2092 Show the version number of @command{objcopy}.
2094 @item --verilog-data-width=@var{bytes}
2095 For Verilog output, this options controls the number of bytes
2096 converted for each output data element. The input target controls the
2097 endianness of the conversion.
2101 Verbose output: list all object files modified. In the case of
2102 archives, @samp{objcopy -V} lists all members of the archive.
2105 Show a summary of the options to @command{objcopy}.
2108 Display a list showing all architectures and object formats available.
2114 @c man begin SEEALSO objcopy
2115 ld(1), objdump(1), and the Info entries for @file{binutils}.
2122 @cindex object file information
2125 @c man title objdump display information from object files
2128 @c man begin SYNOPSIS objdump
2129 objdump [@option{-a}|@option{--archive-headers}]
2130 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2131 [@option{-C}|@option{--demangle}[=@var{style}] ]
2132 [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2133 [@option{-D}|@option{--disassemble-all}]
2134 [@option{-z}|@option{--disassemble-zeroes}]
2135 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2136 [@option{-f}|@option{--file-headers}]
2137 [@option{-F}|@option{--file-offsets}]
2138 [@option{--file-start-context}]
2139 [@option{-g}|@option{--debugging}]
2140 [@option{-e}|@option{--debugging-tags}]
2141 [@option{-h}|@option{--section-headers}|@option{--headers}]
2142 [@option{-i}|@option{--info}]
2143 [@option{-j} @var{section}|@option{--section=}@var{section}]
2144 [@option{-l}|@option{--line-numbers}]
2145 [@option{-S}|@option{--source}]
2146 [@option{--source-comment}[=@var{text}]]
2147 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2148 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2149 [@option{-p}|@option{--private-headers}]
2150 [@option{-P} @var{options}|@option{--private=}@var{options}]
2151 [@option{-r}|@option{--reloc}]
2152 [@option{-R}|@option{--dynamic-reloc}]
2153 [@option{-s}|@option{--full-contents}]
2154 [@option{-W[lLiaprmfFsoRtUuTgAckK]}|
2155 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
2156 [@option{--ctf=}@var{section}]
2157 [@option{-G}|@option{--stabs}]
2158 [@option{-t}|@option{--syms}]
2159 [@option{-T}|@option{--dynamic-syms}]
2160 [@option{-x}|@option{--all-headers}]
2161 [@option{-w}|@option{--wide}]
2162 [@option{--start-address=}@var{address}]
2163 [@option{--stop-address=}@var{address}]
2164 [@option{--prefix-addresses}]
2165 [@option{--[no-]show-raw-insn}]
2166 [@option{--adjust-vma=}@var{offset}]
2167 [@option{--dwarf-depth=@var{n}}]
2168 [@option{--dwarf-start=@var{n}}]
2169 [@option{--ctf-parent=}@var{section}]
2170 [@option{--no-recurse-limit}|@option{--recurse-limit}]
2171 [@option{--special-syms}]
2172 [@option{--prefix=}@var{prefix}]
2173 [@option{--prefix-strip=}@var{level}]
2174 [@option{--insn-width=}@var{width}]
2175 [@option{--visualize-jumps[=color|=extended-color|=off]}
2176 [@option{-V}|@option{--version}]
2177 [@option{-H}|@option{--help}]
2178 @var{objfile}@dots{}
2182 @c man begin DESCRIPTION objdump
2184 @command{objdump} displays information about one or more object files.
2185 The options control what particular information to display. This
2186 information is mostly useful to programmers who are working on the
2187 compilation tools, as opposed to programmers who just want their
2188 program to compile and work.
2190 @var{objfile}@dots{} are the object files to be examined. When you
2191 specify archives, @command{objdump} shows information on each of the member
2196 @c man begin OPTIONS objdump
2198 The long and short forms of options, shown here as alternatives, are
2199 equivalent. At least one option from the list
2200 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2204 @itemx --archive-header
2205 @cindex archive headers
2206 If any of the @var{objfile} files are archives, display the archive
2207 header information (in a format similar to @samp{ls -l}). Besides the
2208 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2209 the object file format of each archive member.
2211 @item --adjust-vma=@var{offset}
2212 @cindex section addresses in objdump
2213 @cindex VMA in objdump
2214 When dumping information, first add @var{offset} to all the section
2215 addresses. This is useful if the section addresses do not correspond to
2216 the symbol table, which can happen when putting sections at particular
2217 addresses when using a format which can not represent section addresses,
2220 @item -b @var{bfdname}
2221 @itemx --target=@var{bfdname}
2222 @cindex object code format
2223 Specify that the object-code format for the object files is
2224 @var{bfdname}. This option may not be necessary; @var{objdump} can
2225 automatically recognize many formats.
2229 objdump -b oasys -m vax -h fu.o
2232 displays summary information from the section headers (@option{-h}) of
2233 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2234 file in the format produced by Oasys compilers. You can list the
2235 formats available with the @option{-i} option.
2236 @xref{Target Selection}, for more information.
2239 @itemx --demangle[=@var{style}]
2240 @cindex demangling in objdump
2241 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2242 Besides removing any initial underscore prepended by the system, this
2243 makes C++ function names readable. Different compilers have different
2244 mangling styles. The optional demangling style argument can be used to
2245 choose an appropriate demangling style for your compiler. @xref{c++filt},
2246 for more information on demangling.
2248 @item --recurse-limit
2249 @itemx --no-recurse-limit
2250 @itemx --recursion-limit
2251 @itemx --no-recursion-limit
2252 Enables or disables a limit on the amount of recursion performed
2253 whilst demangling strings. Since the name mangling formats allow for
2254 an inifinite level of recursion it is possible to create strings whose
2255 decoding will exhaust the amount of stack space available on the host
2256 machine, triggering a memory fault. The limit tries to prevent this
2257 from happening by restricting recursion to 2048 levels of nesting.
2259 The default is for this limit to be enabled, but disabling it may be
2260 necessary in order to demangle truly complicated names. Note however
2261 that if the recursion limit is disabled then stack exhaustion is
2262 possible and any bug reports about such an event will be rejected.
2266 Display debugging information. This attempts to parse STABS
2267 debugging format information stored in the file and print it out using
2268 a C like syntax. If no STABS debugging was found this option
2269 falls back on the @option{-W} option to print any DWARF information in
2273 @itemx --debugging-tags
2274 Like @option{-g}, but the information is generated in a format compatible
2278 @itemx --disassemble
2279 @itemx --disassemble=@var{symbol}
2280 @cindex disassembling object code
2281 @cindex machine instructions
2282 Display the assembler mnemonics for the machine instructions from the
2283 input file. This option only disassembles those sections which are
2284 expected to contain instructions. If the optional @var{symbol}
2285 argument is given, then display the assembler mnemonics starting at
2286 @var{symbol}. If @var{symbol} is a function name then disassembly
2287 will stop at the end of the function, otherwise it will stop when the
2288 next symbol is encountered. If there are no matches for @var{symbol}
2289 then nothing will be displayed.
2291 Note if the @option{--dwarf=follow-links} option has also been enabled
2292 then any symbol tables in linked debug info files will be read in and
2293 used when disassembling.
2296 @itemx --disassemble-all
2297 Like @option{-d}, but disassemble the contents of all sections, not just
2298 those expected to contain instructions.
2300 This option also has a subtle effect on the disassembly of
2301 instructions in code sections. When option @option{-d} is in effect
2302 objdump will assume that any symbols present in a code section occur
2303 on the boundary between instructions and it will refuse to disassemble
2304 across such a boundary. When option @option{-D} is in effect however
2305 this assumption is supressed. This means that it is possible for the
2306 output of @option{-d} and @option{-D} to differ if, for example, data
2307 is stored in code sections.
2309 If the target is an ARM architecture this switch also has the effect
2310 of forcing the disassembler to decode pieces of data found in code
2311 sections as if they were instructions.
2313 Note if the @option{--dwarf=follow-links} option has also been enabled
2314 then any symbol tables in linked debug info files will be read in and
2315 used when disassembling.
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. Multiple selections from the
2467 following may be specified as a comma separated string.
2472 Select disassembly for the given architecture.
2476 Select between intel syntax mode and AT&T syntax mode.
2480 Select between AMD64 ISA and Intel64 ISA.
2482 @item intel-mnemonic
2484 Select between intel mnemonic mode and AT&T mnemonic mode.
2485 Note: @code{intel-mnemonic} implies @code{intel} and
2486 @code{att-mnemonic} implies @code{att}.
2493 Specify the default address size and operand size. These five options
2494 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2495 appear later in the option string.
2498 When in AT&T mode, instructs the disassembler to print a mnemonic
2499 suffix even when the suffix could be inferred by the operands.
2502 For PowerPC, the @option{-M} argument @option{raw} selects
2503 disasssembly of hardware insns rather than aliases. For example, you
2504 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2505 rather than @code{li}. All of the @option{-m} arguments for
2506 @command{gas} that select a CPU are supported. These are:
2507 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2508 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2509 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2510 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2511 @option{booke32}, @option{cell}, @option{com}, @option{e200z4},
2512 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2513 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2514 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2515 @option{power8}, @option{power9}, @option{ppc}, @option{ppc32},
2516 @option{ppc64}, @option{ppc64bridge}, @option{ppcps}, @option{pwr},
2517 @option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2518 @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9},
2519 @option{pwrx}, @option{titan}, and @option{vle}.
2520 @option{32} and @option{64} modify the default or a prior CPU
2521 selection, disabling and enabling 64-bit insns respectively. In
2522 addition, @option{altivec}, @option{any}, @option{htm}, @option{vsx},
2523 and @option{spe} add capabilities to a previous @emph{or later} CPU
2524 selection. @option{any} will disassemble any opcode known to
2525 binutils, but in cases where an opcode has two different meanings or
2526 different arguments, you may not see the disassembly you expect.
2527 If you disassemble without giving a CPU selection, a default will be
2528 chosen from information gleaned by BFD from the object files headers,
2529 but the result again may not be as you expect.
2531 For MIPS, this option controls the printing of instruction mnemonic
2532 names and register names in disassembled instructions. Multiple
2533 selections from the following may be specified as a comma separated
2534 string, and invalid options are ignored:
2538 Print the 'raw' instruction mnemonic instead of some pseudo
2539 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2540 'sll' instead of 'nop', etc.
2543 Disassemble MSA instructions.
2546 Disassemble the virtualization ASE instructions.
2549 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2551 @item gpr-names=@var{ABI}
2552 Print GPR (general-purpose register) names as appropriate
2553 for the specified ABI. By default, GPR names are selected according to
2554 the ABI of the binary being disassembled.
2556 @item fpr-names=@var{ABI}
2557 Print FPR (floating-point register) names as
2558 appropriate for the specified ABI. By default, FPR numbers are printed
2561 @item cp0-names=@var{ARCH}
2562 Print CP0 (system control coprocessor; coprocessor 0) register names
2563 as appropriate for the CPU or architecture specified by
2564 @var{ARCH}. By default, CP0 register names are selected according to
2565 the architecture and CPU of the binary being disassembled.
2567 @item hwr-names=@var{ARCH}
2568 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2569 as appropriate for the CPU or architecture specified by
2570 @var{ARCH}. By default, HWR names are selected according to
2571 the architecture and CPU of the binary being disassembled.
2573 @item reg-names=@var{ABI}
2574 Print GPR and FPR names as appropriate for the selected ABI.
2576 @item reg-names=@var{ARCH}
2577 Print CPU-specific register names (CP0 register and HWR names)
2578 as appropriate for the selected CPU or architecture.
2581 For any of the options listed above, @var{ABI} or
2582 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2583 rather than names, for the selected types of registers.
2584 You can list the available values of @var{ABI} and @var{ARCH} using
2585 the @option{--help} option.
2587 For VAX, you can specify function entry addresses with @option{-M
2588 entry:0xf00ba}. You can use this multiple times to properly
2589 disassemble VAX binary files that don't contain symbol tables (like
2590 ROM dumps). In these cases, the function entry mask would otherwise
2591 be decoded as VAX instructions, which would probably lead the rest
2592 of the function being wrongly disassembled.
2595 @itemx --private-headers
2596 Print information that is specific to the object file format. The exact
2597 information printed depends upon the object file format. For some
2598 object file formats, no additional information is printed.
2600 @item -P @var{options}
2601 @itemx --private=@var{options}
2602 Print information that is specific to the object file format. The
2603 argument @var{options} is a comma separated list that depends on the
2604 format (the lists of options is displayed with the help).
2606 For XCOFF, the available options are:
2622 Not all object formats support this option. In particular the ELF
2623 format does not use it.
2627 @cindex relocation entries, in object file
2628 Print the relocation entries of the file. If used with @option{-d} or
2629 @option{-D}, the relocations are printed interspersed with the
2633 @itemx --dynamic-reloc
2634 @cindex dynamic relocation entries, in object file
2635 Print the dynamic relocation entries of the file. This is only
2636 meaningful for dynamic objects, such as certain types of shared
2637 libraries. As for @option{-r}, if used with @option{-d} or
2638 @option{-D}, the relocations are printed interspersed with the
2642 @itemx --full-contents
2643 @cindex sections, full contents
2644 @cindex object file sections
2645 Display the full contents of any sections requested. By default all
2646 non-empty sections are displayed.
2650 @cindex source disassembly
2651 @cindex disassembly, with source
2652 Display source code intermixed with disassembly, if possible. Implies
2655 @item --source-comment[=@var{txt}]
2656 @cindex source disassembly
2657 @cindex disassembly, with source
2658 Like the @option{-S} option, but all source code lines are displayed
2659 with a prefix of @var{txt}. Typically @var{txt} will be a comment
2660 string which can be used to distinguish the assembler code from the
2661 source code. If @var{txt} is not provided then a default string of
2662 @var{``# ``} (hash followed by a space), will be used.
2664 @item --prefix=@var{prefix}
2665 @cindex Add prefix to absolute paths
2666 Specify @var{prefix} to add to the absolute paths when used with
2669 @item --prefix-strip=@var{level}
2670 @cindex Strip absolute paths
2671 Indicate how many initial directory names to strip off the hardwired
2672 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2674 @item --show-raw-insn
2675 When disassembling instructions, print the instruction in hex as well as
2676 in symbolic form. This is the default except when
2677 @option{--prefix-addresses} is used.
2679 @item --no-show-raw-insn
2680 When disassembling instructions, do not print the instruction bytes.
2681 This is the default when @option{--prefix-addresses} is used.
2683 @item --insn-width=@var{width}
2684 @cindex Instruction width
2685 Display @var{width} bytes on a single line when disassembling
2688 @item --visualize-jumps[=color|=extended-color|=off]
2689 Visualize jumps that stay inside a function by drawing ASCII art between
2690 the start and target addresses. The optional @option{=color} argument
2691 adds color to the output using simple terminal colors. Alternatively
2692 the @option{=extended-color} argument will add color using 8bit
2693 colors, but these might not work on all terminals.
2695 If it is necessary to disable the @option{visualize-jumps} option
2696 after it has previously been enabled then use
2697 @option{visualize-jumps=off}.
2699 @item -W[lLiaprmfFsoRtUuTgAckK]
2700 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2701 @include debug.options.texi
2704 Enable additional checks for consistency of Dwarf information.
2706 @include ctf.options.texi
2712 @cindex debug symbols
2713 @cindex ELF object file format
2714 Display the full contents of any sections requested. Display the
2715 contents of the .stab and .stab.index and .stab.excl sections from an
2716 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2717 @code{.stab} debugging symbol-table entries are carried in an ELF
2718 section. In most other file formats, debugging symbol-table entries are
2719 interleaved with linkage symbols, and are visible in the @option{--syms}
2722 @item --start-address=@var{address}
2723 @cindex start-address
2724 Start displaying data at the specified address. This affects the output
2725 of the @option{-d}, @option{-r} and @option{-s} options.
2727 @item --stop-address=@var{address}
2728 @cindex stop-address
2729 Stop displaying data at the specified address. This affects the output
2730 of the @option{-d}, @option{-r} and @option{-s} options.
2734 @cindex symbol table entries, printing
2735 Print the symbol table entries of the file.
2736 This is similar to the information provided by the @samp{nm} program,
2737 although the display format is different. The format of the output
2738 depends upon the format of the file being dumped, but there are two main
2739 types. One looks like this:
2742 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2743 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2746 where the number inside the square brackets is the number of the entry
2747 in the symbol table, the @var{sec} number is the section number, the
2748 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2749 symbol's type, the @var{scl} number is the symbol's storage class and
2750 the @var{nx} value is the number of auxilary entries associated with
2751 the symbol. The last two fields are the symbol's value and its name.
2753 The other common output format, usually seen with ELF based files,
2757 00000000 l d .bss 00000000 .bss
2758 00000000 g .text 00000000 fred
2761 Here the first number is the symbol's value (sometimes refered to as
2762 its address). The next field is actually a set of characters and
2763 spaces indicating the flag bits that are set on the symbol. These
2764 characters are described below. Next is the section with which the
2765 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2766 not connected with any section), or @emph{*UND*} if the section is
2767 referenced in the file being dumped, but not defined there.
2769 After the section name comes another field, a number, which for common
2770 symbols is the alignment and for other symbol is the size. Finally
2771 the symbol's name is displayed.
2773 The flag characters are divided into 7 groups as follows:
2779 The symbol is a local (l), global (g), unique global (u), neither
2780 global nor local (a space) or both global and local (!). A
2781 symbol can be neither local or global for a variety of reasons, e.g.,
2782 because it is used for debugging, but it is probably an indication of
2783 a bug if it is ever both local and global. Unique global symbols are
2784 a GNU extension to the standard set of ELF symbol bindings. For such
2785 a symbol the dynamic linker will make sure that in the entire process
2786 there is just one symbol with this name and type in use.
2789 The symbol is weak (w) or strong (a space).
2792 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2795 The symbol is a warning (W) or a normal symbol (a space). A warning
2796 symbol's name is a message to be displayed if the symbol following the
2797 warning symbol is ever referenced.
2801 The symbol is an indirect reference to another symbol (I), a function
2802 to be evaluated during reloc processing (i) or a normal symbol (a
2807 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2808 normal symbol (a space).
2813 The symbol is the name of a function (F) or a file (f) or an object
2814 (O) or just a normal symbol (a space).
2818 @itemx --dynamic-syms
2819 @cindex dynamic symbol table entries, printing
2820 Print the dynamic symbol table entries of the file. This is only
2821 meaningful for dynamic objects, such as certain types of shared
2822 libraries. This is similar to the information provided by the @samp{nm}
2823 program when given the @option{-D} (@option{--dynamic}) option.
2825 The output format is similar to that produced by the @option{--syms}
2826 option, except that an extra field is inserted before the symbol's
2827 name, giving the version information associated with the symbol.
2828 If the version is the default version to be used when resolving
2829 unversioned references to the symbol then it's displayed as is,
2830 otherwise it's put into parentheses.
2832 @item --special-syms
2833 When displaying symbols include those which the target considers to be
2834 special in some way and which would not normally be of interest to the
2839 Print the version number of @command{objdump} and exit.
2842 @itemx --all-headers
2843 @cindex all header information, object file
2844 @cindex header information, all
2845 Display all available header information, including the symbol table and
2846 relocation entries. Using @option{-x} is equivalent to specifying all of
2847 @option{-a -f -h -p -r -t}.
2851 @cindex wide output, printing
2852 Format some lines for output devices that have more than 80 columns.
2853 Also do not truncate symbol names when they are displayed.
2856 @itemx --disassemble-zeroes
2857 Normally the disassembly output will skip blocks of zeroes. This
2858 option directs the disassembler to disassemble those blocks, just like
2865 @c man begin SEEALSO objdump
2866 nm(1), readelf(1), and the Info entries for @file{binutils}.
2874 @cindex archive contents
2875 @cindex symbol index
2877 @c man title ranlib generate an index to an archive
2880 @c man begin SYNOPSIS ranlib
2881 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2885 @c man begin DESCRIPTION ranlib
2887 @command{ranlib} generates an index to the contents of an archive and
2888 stores it in the archive. The index lists each symbol defined by a
2889 member of an archive that is a relocatable object file.
2891 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2893 An archive with such an index speeds up linking to the library and
2894 allows routines in the library to call each other without regard to
2895 their placement in the archive.
2897 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2898 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2903 @c man begin OPTIONS ranlib
2909 Show usage information for @command{ranlib}.
2914 Show the version number of @command{ranlib}.
2917 @cindex deterministic archives
2918 @kindex --enable-deterministic-archives
2919 Operate in @emph{deterministic} mode. The symbol map archive member's
2920 header will show zero for the UID, GID, and timestamp. When this
2921 option is used, multiple runs will produce identical output files.
2923 If @file{binutils} was configured with
2924 @option{--enable-deterministic-archives}, then this mode is on by
2925 default. It can be disabled with the @samp{-U} option, described
2929 Update the timestamp of the symbol map of an archive.
2932 @cindex deterministic archives
2933 @kindex --enable-deterministic-archives
2934 Do @emph{not} operate in @emph{deterministic} mode. This is the
2935 inverse of the @samp{-D} option, above: the archive index will get
2936 actual UID, GID, timestamp, and file mode values.
2938 If @file{binutils} was configured @emph{without}
2939 @option{--enable-deterministic-archives}, then this mode is on by
2947 @c man begin SEEALSO ranlib
2948 ar(1), nm(1), and the Info entries for @file{binutils}.
2956 @cindex section sizes
2958 @c man title size list section sizes and total size of binary files
2961 @c man begin SYNOPSIS size
2962 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
2964 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2966 [@option{-t}|@option{--totals}]
2967 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2968 [@var{objfile}@dots{}]
2972 @c man begin DESCRIPTION size
2974 The @sc{gnu} @command{size} utility lists the section sizes and the total
2975 size for each of the binary files @var{objfile} on its argument list.
2976 By default, one line of output is generated for each file or each
2977 module if the file is an archive.
2979 @var{objfile}@dots{} are the files to be examined. If none are
2980 specified, the file @code{a.out} will be used instead.
2984 @c man begin OPTIONS size
2986 The command-line options have the following meanings:
2992 @itemx --format=@var{compatibility}
2993 @cindex @command{size} display format
2994 Using one of these options, you can choose whether the output from @sc{gnu}
2995 @command{size} resembles output from System V @command{size} (using @option{-A},
2996 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2997 @option{--format=berkeley}). The default is the one-line format similar to
2998 Berkeley's. Alternatively, you can choose the GNU format output
2999 (using @option{-G}, or @option{--format=gnu}), this is similar to
3000 Berkeley's output format, but sizes are counted differently.
3001 @c Bonus for doc-source readers: you can also say --format=strange (or
3002 @c anything else that starts with 's') for sysv, and --format=boring (or
3003 @c anything else that starts with 'b') for Berkeley.
3005 Here is an example of the Berkeley (default) format of output from
3008 $ size --format=Berkeley ranlib size
3009 text data bss dec hex filename
3010 294880 81920 11592 388392 5ed28 ranlib
3011 294880 81920 11888 388688 5ee50 size
3014 The Berkeley style output counts read only data in the @code{text}
3015 column, not in the @code{data} column, the @code{dec} and @code{hex}
3016 columns both display the sum of the @code{text}, @code{data}, and
3017 @code{bss} columns in decimal and hexadecimal respectively.
3019 The GNU format counts read only data in the @code{data} column, not
3020 the @code{text} column, and only displays the sum of the @code{text},
3021 @code{data}, and @code{bss} columns once, in the @code{total} column.
3022 The @option{--radix} option can be used to change the number base for
3023 all columns. Here is the same data displayed with GNU conventions:
3026 $ size --format=GNU ranlib size
3027 text data bss total filename
3028 279880 96920 11592 388392 ranlib
3029 279880 96920 11888 388688 size
3033 This is the same data, but displayed closer to System V conventions:
3036 $ size --format=SysV ranlib size
3054 Show a summary of acceptable arguments and options.
3059 @itemx --radix=@var{number}
3060 @cindex @command{size} number format
3061 @cindex radix for section sizes
3062 Using one of these options, you can control whether the size of each
3063 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3064 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3065 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
3066 values (8, 10, 16) are supported. The total size is always given in two
3067 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3068 octal and hexadecimal if you're using @option{-o}.
3071 Print total size of common symbols in each file. When using Berkeley
3072 or GNU format these are included in the bss size.
3076 Show totals of all objects listed (Berkeley or GNU format mode only).
3078 @item --target=@var{bfdname}
3079 @cindex object code format
3080 Specify that the object-code format for @var{objfile} is
3081 @var{bfdname}. This option may not be necessary; @command{size} can
3082 automatically recognize many formats.
3083 @xref{Target Selection}, for more information.
3087 Display the version number of @command{size}.
3093 @c man begin SEEALSO size
3094 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3101 @cindex listings strings
3102 @cindex printing strings
3103 @cindex strings, printing
3105 @c man title strings print the sequences of printable characters in files
3108 @c man begin SYNOPSIS strings
3109 strings [@option{-afovV}] [@option{-}@var{min-len}]
3110 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3111 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3112 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3113 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3114 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3115 [@option{-w}] [@option{--include-all-whitespace}]
3116 [@option{-s}] [@option{--output-separator}@var{sep_string}]
3117 [@option{--help}] [@option{--version}] @var{file}@dots{}
3121 @c man begin DESCRIPTION strings
3123 For each @var{file} given, @sc{gnu} @command{strings} prints the
3124 printable character sequences that are at least 4 characters long (or
3125 the number given with the options below) and are followed by an
3126 unprintable character.
3128 Depending upon how the strings program was configured it will default
3129 to either displaying all the printable sequences that it can find in
3130 each file, or only those sequences that are in loadable, initialized
3131 data sections. If the file type in unrecognizable, or if strings is
3132 reading from stdin then it will always display all of the printable
3133 sequences that it can find.
3135 For backwards compatibility any file that occurs after a command-line
3136 option of just @option{-} will also be scanned in full, regardless of
3137 the presence of any @option{-d} option.
3139 @command{strings} is mainly useful for determining the contents of
3144 @c man begin OPTIONS strings
3150 Scan the whole file, regardless of what sections it contains or
3151 whether those sections are loaded or initialized. Normally this is
3152 the default behaviour, but strings can be configured so that the
3153 @option{-d} is the default instead.
3155 The @option{-} option is position dependent and forces strings to
3156 perform full scans of any file that is mentioned after the @option{-}
3157 on the command line, even if the @option{-d} option has been
3162 Only print strings from initialized, loaded data sections in the
3163 file. This may reduce the amount of garbage in the output, but it
3164 also exposes the strings program to any security flaws that may be
3165 present in the BFD library used to scan and load sections. Strings
3166 can be configured so that this option is the default behaviour. In
3167 such cases the @option{-a} option can be used to avoid using the BFD
3168 library and instead just print all of the strings found in the file.
3171 @itemx --print-file-name
3172 Print the name of the file before each string.
3175 Print a summary of the program usage on the standard output and exit.
3177 @item -@var{min-len}
3178 @itemx -n @var{min-len}
3179 @itemx --bytes=@var{min-len}
3180 Print sequences of characters that are at least @var{min-len} characters
3181 long, instead of the default 4.
3184 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3185 act like @samp{-t d} instead. Since we can not be compatible with both
3186 ways, we simply chose one.
3188 @item -t @var{radix}
3189 @itemx --radix=@var{radix}
3190 Print the offset within the file before each string. The single
3191 character argument specifies the radix of the offset---@samp{o} for
3192 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3194 @item -e @var{encoding}
3195 @itemx --encoding=@var{encoding}
3196 Select the character encoding of the strings that are to be found.
3197 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3198 characters (ASCII, ISO 8859, etc., default), @samp{S} =
3199 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3200 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3201 littleendian. Useful for finding wide character strings. (@samp{l}
3202 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3204 @item -T @var{bfdname}
3205 @itemx --target=@var{bfdname}
3206 @cindex object code format
3207 Specify an object code format other than your system's default format.
3208 @xref{Target Selection}, for more information.
3213 Print the program version number on the standard output and exit.
3216 @itemx --include-all-whitespace
3217 By default tab and space characters are included in the strings that
3218 are displayed, but other whitespace characters, such a newlines and
3219 carriage returns, are not. The @option{-w} option changes this so
3220 that all whitespace characters are considered to be part of a string.
3223 @itemx --output-separator
3224 By default, output strings are delimited by a new-line. This option
3225 allows you to supply any string to be used as the output record
3226 separator. Useful with --include-all-whitespace where strings
3227 may contain new-lines internally.
3233 @c man begin SEEALSO strings
3234 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3235 and the Info entries for @file{binutils}.
3243 @cindex removing symbols
3244 @cindex discarding symbols
3245 @cindex symbols, discarding
3247 @c man title strip discard symbols and other data from object files
3250 @c man begin SYNOPSIS strip
3251 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3252 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3253 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3254 [@option{-s}|@option{--strip-all}]
3255 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3256 [@option{--strip-dwo}]
3257 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3258 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3259 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3260 [@option{-w}|@option{--wildcard}]
3261 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3262 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3263 [@option{--keep-section=}@var{sectionpattern}]
3264 [@option{--remove-relocations=}@var{sectionpattern}]
3265 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3266 [@option{-D}|@option{--enable-deterministic-archives}]
3267 [@option{-U}|@option{--disable-deterministic-archives}]
3268 [@option{--keep-file-symbols}]
3269 [@option{--only-keep-debug}]
3270 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3271 [@option{--help}] [@option{--info}]
3272 @var{objfile}@dots{}
3276 @c man begin DESCRIPTION strip
3278 @sc{gnu} @command{strip} discards all symbols from object files
3279 @var{objfile}. The list of object files may include archives.
3280 At least one object file must be given.
3282 @command{strip} modifies the files named in its argument,
3283 rather than writing modified copies under different names.
3287 @c man begin OPTIONS strip
3290 @item -F @var{bfdname}
3291 @itemx --target=@var{bfdname}
3292 Treat the original @var{objfile} as a file with the object
3293 code format @var{bfdname}, and rewrite it in the same format.
3294 @xref{Target Selection}, for more information.
3297 Show a summary of the options to @command{strip} and exit.
3300 Display a list showing all architectures and object formats available.
3302 @item -I @var{bfdname}
3303 @itemx --input-target=@var{bfdname}
3304 Treat the original @var{objfile} as a file with the object
3305 code format @var{bfdname}.
3306 @xref{Target Selection}, for more information.
3308 @item -O @var{bfdname}
3309 @itemx --output-target=@var{bfdname}
3310 Replace @var{objfile} with a file in the output format @var{bfdname}.
3311 @xref{Target Selection}, for more information.
3313 @item -R @var{sectionname}
3314 @itemx --remove-section=@var{sectionname}
3315 Remove any section named @var{sectionname} from the output file, in
3316 addition to whatever sections would otherwise be removed. This
3317 option may be given more than once. Note that using this option
3318 inappropriately may make the output file unusable. The wildcard
3319 character @samp{*} may be given at the end of @var{sectionname}. If
3320 so, then any section starting with @var{sectionname} will be removed.
3322 If the first character of @var{sectionpattern} is the exclamation
3323 point (!) then matching sections will not be removed even if an
3324 earlier use of @option{--remove-section} on the same command line
3325 would otherwise remove it. For example:
3328 --remove-section=.text.* --remove-section=!.text.foo
3331 will remove all sections matching the pattern '.text.*', but will not
3332 remove the section '.text.foo'.
3334 @item --keep-section=@var{sectionpattern}
3335 When removing sections from the output file, keep sections that match
3336 @var{sectionpattern}.
3338 @item --remove-relocations=@var{sectionpattern}
3339 Remove relocations from the output file for any section matching
3340 @var{sectionpattern}. This option may be given more than once. Note
3341 that using this option inappropriately may make the output file
3342 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3346 --remove-relocations=.text.*
3349 will remove the relocations for all sections matching the patter
3352 If the first character of @var{sectionpattern} is the exclamation
3353 point (!) then matching sections will not have their relocation
3354 removed even if an earlier use of @option{--remove-relocations} on the
3355 same command line would otherwise cause the relocations to be removed.
3359 --remove-relocations=.text.* --remove-relocations=!.text.foo
3362 will remove all relocations for sections matching the pattern
3363 '.text.*', but will not remove relocations for the section
3373 @itemx --strip-debug
3374 Remove debugging symbols only.
3377 Remove the contents of all DWARF .dwo sections, leaving the
3378 remaining debugging sections and all symbols intact.
3379 See the description of this option in the @command{objcopy} section
3380 for more information.
3382 @item --strip-unneeded
3383 Remove all symbols that are not needed for relocation processing.
3385 @item -K @var{symbolname}
3386 @itemx --keep-symbol=@var{symbolname}
3387 When stripping symbols, keep symbol @var{symbolname} even if it would
3388 normally be stripped. This option may be given more than once.
3391 @itemx --merge-notes
3392 @itemx --no-merge-notes
3393 For ELF files, attempt (or do not attempt) to reduce the size of any
3394 SHT_NOTE type sections by removing duplicate notes. The default is to
3395 attempt this reduction unless stripping debug or DWO information.
3397 @item -N @var{symbolname}
3398 @itemx --strip-symbol=@var{symbolname}
3399 Remove symbol @var{symbolname} from the source file. This option may be
3400 given more than once, and may be combined with strip options other than
3404 Put the stripped output in @var{file}, rather than replacing the
3405 existing file. When this argument is used, only one @var{objfile}
3406 argument may be specified.
3409 @itemx --preserve-dates
3410 Preserve the access and modification dates of the file.
3413 @itemx --enable-deterministic-archives
3414 @cindex deterministic archives
3415 @kindex --enable-deterministic-archives
3416 Operate in @emph{deterministic} mode. When copying archive members
3417 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3418 and use consistent file modes for all files.
3420 If @file{binutils} was configured with
3421 @option{--enable-deterministic-archives}, then this mode is on by default.
3422 It can be disabled with the @samp{-U} option, below.
3425 @itemx --disable-deterministic-archives
3426 @cindex deterministic archives
3427 @kindex --enable-deterministic-archives
3428 Do @emph{not} operate in @emph{deterministic} mode. This is the
3429 inverse of the @option{-D} option, above: when copying archive members
3430 and writing the archive index, use their actual UID, GID, timestamp,
3431 and file mode values.
3433 This is the default unless @file{binutils} was configured with
3434 @option{--enable-deterministic-archives}.
3438 Permit regular expressions in @var{symbolname}s used in other command
3439 line options. The question mark (?), asterisk (*), backslash (\) and
3440 square brackets ([]) operators can be used anywhere in the symbol
3441 name. If the first character of the symbol name is the exclamation
3442 point (!) then the sense of the switch is reversed for that symbol.
3449 would cause strip to only keep symbols that start with the letters
3450 ``fo'', but to discard the symbol ``foo''.
3453 @itemx --discard-all
3454 Remove non-global symbols.
3457 @itemx --discard-locals
3458 Remove compiler-generated local symbols.
3459 (These usually start with @samp{L} or @samp{.}.)
3461 @item --keep-file-symbols
3462 When stripping a file, perhaps with @option{--strip-debug} or
3463 @option{--strip-unneeded}, retain any symbols specifying source file names,
3464 which would otherwise get stripped.
3466 @item --only-keep-debug
3467 Strip a file, emptying the contents of any sections that would not be
3468 stripped by @option{--strip-debug} and leaving the debugging sections
3469 intact. In ELF files, this preserves all the note sections in the
3472 Note - the section headers of the stripped sections are preserved,
3473 including their sizes, but the contents of the section are discarded.
3474 The section headers are preserved so that other tools can match up the
3475 debuginfo file with the real executable, even if that executable has
3476 been relocated to a different address space.
3478 The intention is that this option will be used in conjunction with
3479 @option{--add-gnu-debuglink} to create a two part executable. One a
3480 stripped binary which will occupy less space in RAM and in a
3481 distribution and the second a debugging information file which is only
3482 needed if debugging abilities are required. The suggested procedure
3483 to create these files is as follows:
3486 @item Link the executable as normal. Assuming that it is called
3488 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3489 create a file containing the debugging info.
3490 @item Run @code{objcopy --strip-debug foo} to create a
3491 stripped executable.
3492 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3493 to add a link to the debugging info into the stripped executable.
3496 Note---the choice of @code{.dbg} as an extension for the debug info
3497 file is arbitrary. Also the @code{--only-keep-debug} step is
3498 optional. You could instead do this:
3501 @item Link the executable as normal.
3502 @item Copy @code{foo} to @code{foo.full}
3503 @item Run @code{strip --strip-debug foo}
3504 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3507 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3508 full executable. It does not have to be a file created by the
3509 @option{--only-keep-debug} switch.
3511 Note---this switch is only intended for use on fully linked files. It
3512 does not make sense to use it on object files where the debugging
3513 information may be incomplete. Besides the gnu_debuglink feature
3514 currently only supports the presence of one filename containing
3515 debugging information, not multiple filenames on a one-per-object-file
3520 Show the version number for @command{strip}.
3524 Verbose output: list all object files modified. In the case of
3525 archives, @samp{strip -v} lists all members of the archive.
3531 @c man begin SEEALSO strip
3532 the Info entries for @file{binutils}.
3536 @node c++filt, addr2line, strip, Top
3540 @cindex demangling C++ symbols
3542 @c man title cxxfilt demangle C++ and Java symbols
3545 @c man begin SYNOPSIS cxxfilt
3546 c++filt [@option{-_}|@option{--strip-underscore}]
3547 [@option{-n}|@option{--no-strip-underscore}]
3548 [@option{-p}|@option{--no-params}]
3549 [@option{-t}|@option{--types}]
3550 [@option{-i}|@option{--no-verbose}]
3551 [@option{-r}|@option{--no-recurse-limit}]
3552 [@option{-R}|@option{--recurse-limit}]
3553 [@option{-s} @var{format}|@option{--format=}@var{format}]
3554 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3558 @c man begin DESCRIPTION cxxfilt
3561 The C++ and Java languages provide function overloading, which means
3562 that you can write many functions with the same name, providing that
3563 each function takes parameters of different types. In order to be
3564 able to distinguish these similarly named functions C++ and Java
3565 encode them into a low-level assembler name which uniquely identifies
3566 each different version. This process is known as @dfn{mangling}. The
3568 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3569 MS-DOS this program is named @command{CXXFILT}.}
3570 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3571 names into user-level names so that they can be read.
3573 Every alphanumeric word (consisting of letters, digits, underscores,
3574 dollars, or periods) seen in the input is a potential mangled name.
3575 If the name decodes into a C++ name, the C++ name replaces the
3576 low-level name in the output, otherwise the original word is output.
3577 In this way you can pass an entire assembler source file, containing
3578 mangled names, through @command{c++filt} and see the same source file
3579 containing demangled names.
3581 You can also use @command{c++filt} to decipher individual symbols by
3582 passing them on the command line:
3585 c++filt @var{symbol}
3588 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3589 names from the standard input instead. All the results are printed on
3590 the standard output. The difference between reading names from the
3591 command line versus reading names from the standard input is that
3592 command-line arguments are expected to be just mangled names and no
3593 checking is performed to separate them from surrounding text. Thus
3600 will work and demangle the name to ``f()'' whereas:
3606 will not work. (Note the extra comma at the end of the mangled
3607 name which makes it invalid). This command however will work:
3610 echo _Z1fv, | c++filt -n
3613 and will display ``f(),'', i.e., the demangled name followed by a
3614 trailing comma. This behaviour is because when the names are read
3615 from the standard input it is expected that they might be part of an
3616 assembler source file where there might be extra, extraneous
3617 characters trailing after a mangled name. For example:
3620 .type _Z1fv, @@function
3625 @c man begin OPTIONS cxxfilt
3629 @itemx --strip-underscore
3630 On some systems, both the C and C++ compilers put an underscore in front
3631 of every name. For example, the C name @code{foo} gets the low-level
3632 name @code{_foo}. This option removes the initial underscore. Whether
3633 @command{c++filt} removes the underscore by default is target dependent.
3636 @itemx --no-strip-underscore
3637 Do not remove the initial underscore.
3641 When demangling the name of a function, do not display the types of
3642 the function's parameters.
3646 Attempt to demangle types as well as function names. This is disabled
3647 by default since mangled types are normally only used internally in
3648 the compiler, and they can be confused with non-mangled names. For example,
3649 a function called ``a'' treated as a mangled type name would be
3650 demangled to ``signed char''.
3654 Do not include implementation details (if any) in the demangled
3659 @itemx --recurse-limit
3660 @itemx --no-recurse-limit
3661 @itemx --recursion-limit
3662 @itemx --no-recursion-limit
3663 Enables or disables a limit on the amount of recursion performed
3664 whilst demangling strings. Since the name mangling formats allow for
3665 an inifinite level of recursion it is possible to create strings whose
3666 decoding will exhaust the amount of stack space available on the host
3667 machine, triggering a memory fault. The limit tries to prevent this
3668 from happening by restricting recursion to 2048 levels of nesting.
3670 The default is for this limit to be enabled, but disabling it may be
3671 necessary in order to demangle truly complicated names. Note however
3672 that if the recursion limit is disabled then stack exhaustion is
3673 possible and any bug reports about such an event will be rejected.
3675 The @option{-r} option is a synonym for the
3676 @option{--no-recurse-limit} option. The @option{-R} option is a
3677 synonym for the @option{--recurse-limit} option.
3679 @item -s @var{format}
3680 @itemx --format=@var{format}
3681 @command{c++filt} can decode various methods of mangling, used by
3682 different compilers. The argument to this option selects which
3687 Automatic selection based on executable (the default method)
3689 the one used by the @sc{gnu} C++ compiler (g++)
3691 the one used by the Lucid compiler (lcc)
3693 the one specified by the C++ Annotated Reference Manual
3695 the one used by the HP compiler (aCC)
3697 the one used by the EDG compiler
3699 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3701 the one used by the @sc{gnu} Java compiler (gcj)
3703 the one used by the @sc{gnu} Ada compiler (GNAT).
3707 Print a summary of the options to @command{c++filt} and exit.
3710 Print the version number of @command{c++filt} and exit.
3716 @c man begin SEEALSO cxxfilt
3717 the Info entries for @file{binutils}.
3722 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3723 user interface are subject to change in future releases. In particular,
3724 a command-line option may be required in the future to decode a name
3725 passed as an argument on the command line; in other words,
3728 c++filt @var{symbol}
3732 may in a future release become
3735 c++filt @var{option} @var{symbol}
3743 @cindex address to file name and line number
3745 @c man title addr2line convert addresses into file names and line numbers
3748 @c man begin SYNOPSIS addr2line
3749 addr2line [@option{-a}|@option{--addresses}]
3750 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3751 [@option{-C}|@option{--demangle}[=@var{style}]]
3752 [@option{-r}|@option{--no-recurse-limit}]
3753 [@option{-R}|@option{--recurse-limit}]
3754 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3755 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3756 [@option{-i}|@option{--inlines}]
3757 [@option{-p}|@option{--pretty-print}]
3758 [@option{-j}|@option{--section=}@var{name}]
3759 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3764 @c man begin DESCRIPTION addr2line
3766 @command{addr2line} translates addresses into file names and line numbers.
3767 Given an address in an executable or an offset in a section of a relocatable
3768 object, it uses the debugging information to figure out which file name and
3769 line number are associated with it.
3771 The executable or relocatable object to use is specified with the @option{-e}
3772 option. The default is the file @file{a.out}. The section in the relocatable
3773 object to use is specified with the @option{-j} option.
3775 @command{addr2line} has two modes of operation.
3777 In the first, hexadecimal addresses are specified on the command line,
3778 and @command{addr2line} displays the file name and line number for each
3781 In the second, @command{addr2line} reads hexadecimal addresses from
3782 standard input, and prints the file name and line number for each
3783 address on standard output. In this mode, @command{addr2line} may be used
3784 in a pipe to convert dynamically chosen addresses.
3786 The format of the output is @samp{FILENAME:LINENO}. By default
3787 each input address generates one line of output.
3789 Two options can generate additional lines before each
3790 @samp{FILENAME:LINENO} line (in that order).
3792 If the @option{-a} option is used then a line with the input address
3795 If the @option{-f} option is used, then a line with the
3796 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3797 containing the address.
3799 One option can generate additional lines after the
3800 @samp{FILENAME:LINENO} line.
3802 If the @option{-i} option is used and the code at the given address is
3803 present there because of inlining by the compiler then additional
3804 lines are displayed afterwards. One or two extra lines (if the
3805 @option{-f} option is used) are displayed for each inlined function.
3807 Alternatively if the @option{-p} option is used then each input
3808 address generates a single, long, output line containing the address,
3809 the function name, the file name and the line number. If the
3810 @option{-i} option has also been used then any inlined functions will
3811 be displayed in the same manner, but on separate lines, and prefixed
3812 by the text @samp{(inlined by)}.
3814 If the file name or function name can not be determined,
3815 @command{addr2line} will print two question marks in their place. If the
3816 line number can not be determined, @command{addr2line} will print 0.
3820 @c man begin OPTIONS addr2line
3822 The long and short forms of options, shown here as alternatives, are
3828 Display the address before the function name, file and line number
3829 information. The address is printed with a @samp{0x} prefix to easily
3832 @item -b @var{bfdname}
3833 @itemx --target=@var{bfdname}
3834 @cindex object code format
3835 Specify that the object-code format for the object files is
3839 @itemx --demangle[=@var{style}]
3840 @cindex demangling in objdump
3841 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3842 Besides removing any initial underscore prepended by the system, this
3843 makes C++ function names readable. Different compilers have different
3844 mangling styles. The optional demangling style argument can be used to
3845 choose an appropriate demangling style for your compiler. @xref{c++filt},
3846 for more information on demangling.
3848 @item -e @var{filename}
3849 @itemx --exe=@var{filename}
3850 Specify the name of the executable for which addresses should be
3851 translated. The default file is @file{a.out}.
3855 Display function names as well as file and line number information.
3859 Display only the base of each file name.
3863 If the address belongs to a function that was inlined, the source
3864 information for all enclosing scopes back to the first non-inlined
3865 function will also be printed. For example, if @code{main} inlines
3866 @code{callee1} which inlines @code{callee2}, and address is from
3867 @code{callee2}, the source information for @code{callee1} and @code{main}
3868 will also be printed.
3872 Read offsets relative to the specified section instead of absolute addresses.
3875 @itemx --pretty-print
3876 Make the output more human friendly: each location are printed on one line.
3877 If option @option{-i} is specified, lines for all enclosing scopes are
3878 prefixed with @samp{(inlined by)}.
3882 @itemx --recurse-limit
3883 @itemx --no-recurse-limit
3884 @itemx --recursion-limit
3885 @itemx --no-recursion-limit
3886 Enables or disables a limit on the amount of recursion performed
3887 whilst demangling strings. Since the name mangling formats allow for
3888 an inifinite level of recursion it is possible to create strings whose
3889 decoding will exhaust the amount of stack space available on the host
3890 machine, triggering a memory fault. The limit tries to prevent this
3891 from happening by restricting recursion to 2048 levels of nesting.
3893 The default is for this limit to be enabled, but disabling it may be
3894 necessary in order to demangle truly complicated names. Note however
3895 that if the recursion limit is disabled then stack exhaustion is
3896 possible and any bug reports about such an event will be rejected.
3898 The @option{-r} option is a synonym for the
3899 @option{--no-recurse-limit} option. The @option{-R} option is a
3900 synonym for the @option{--recurse-limit} option.
3902 Note this option is only effective if the @option{-C} or
3903 @option{--demangle} option has been enabled.
3910 @c man begin SEEALSO addr2line
3911 Info entries for @file{binutils}.
3918 @command{windmc} may be used to generator Windows message resources.
3921 @emph{Warning:} @command{windmc} is not always built as part of the binary
3922 utilities, since it is only useful for Windows targets.
3925 @c man title windmc generates Windows message resources
3928 @c man begin SYNOPSIS windmc
3929 windmc [options] input-file
3933 @c man begin DESCRIPTION windmc
3935 @command{windmc} reads message definitions from an input file (.mc) and
3936 translate them into a set of output files. The output files may be of
3941 A C header file containing the message definitions.
3944 A resource file compilable by the @command{windres} tool.
3947 One or more binary files containing the resource data for a specific
3951 A C include file that maps message id's to their symbolic name.
3954 The exact description of these different formats is available in
3955 documentation from Microsoft.
3957 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3958 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3959 Windows Message Compiler.
3963 @c man begin OPTIONS windmc
3968 Specifies that the input file specified is ASCII. This is the default
3973 Specifies that messages in the output @code{bin} files should be in ASCII
3978 Specifies that @code{bin} filenames should have to be prefixed by the
3979 basename of the source file.
3983 Sets the customer bit in all message id's.
3985 @item -C @var{codepage}
3986 @itemx --codepage_in @var{codepage}
3987 Sets the default codepage to be used to convert input file to UTF16. The
3988 default is ocdepage 1252.
3991 @itemx --decimal_values
3992 Outputs the constants in the header file in decimal. Default is using
3996 @itemx --extension @var{ext}
3997 The extension for the header file. The default is .h extension.
3999 @item -F @var{target}
4000 @itemx --target @var{target}
4001 Specify the BFD format to use for a bin file as output. This
4002 is a BFD target name; you can use the @option{--help} option to see a list
4003 of supported targets. Normally @command{windmc} will use the default
4004 format, which is the first one listed by the @option{--help} option.
4006 @ref{Target Selection}.
4010 @itemx --headerdir @var{path}
4011 The target directory of the generated header file. The default is the
4016 Displays a list of command-line options and then exits.
4018 @item -m @var{characters}
4019 @itemx --maxlength @var{characters}
4020 Instructs @command{windmc} to generate a warning if the length
4021 of any message exceeds the number specified.
4024 @itemx --nullterminate
4025 Terminate message text in @code{bin} files by zero. By default they are
4026 terminated by CR/LF.
4029 @itemx --hresult_use
4030 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
4031 file, using HRESULT definitions. Status codes are used if the flag is not
4034 @item -O @var{codepage}
4035 @itemx --codepage_out @var{codepage}
4036 Sets the default codepage to be used to output text files. The default
4040 @itemx --rcdir @var{path}
4041 The target directory for the generated @code{rc} script and the generated
4042 @code{bin} files that the resource compiler script includes. The default
4043 is the current directory.
4047 Specifies that the input file is UTF16.
4050 @itemx --unicode_out
4051 Specifies that messages in the output @code{bin} file should be in UTF16
4052 format. This is the default behaviour.
4056 Enable verbose mode.
4060 Prints the version number for @command{windmc}.
4063 @itemx --xdgb @var{path}
4064 The path of the @code{dbg} C include file that maps message id's to the
4065 symbolic name. No such file is generated without specifying the switch.
4071 @c man begin SEEALSO windmc
4072 the Info entries for @file{binutils}.
4079 @command{windres} may be used to manipulate Windows resources.
4082 @emph{Warning:} @command{windres} is not always built as part of the binary
4083 utilities, since it is only useful for Windows targets.
4086 @c man title windres manipulate Windows resources
4089 @c man begin SYNOPSIS windres
4090 windres [options] [input-file] [output-file]
4094 @c man begin DESCRIPTION windres
4096 @command{windres} reads resources from an input file and copies them into
4097 an output file. Either file may be in one of three formats:
4101 A text format read by the Resource Compiler.
4104 A binary format generated by the Resource Compiler.
4107 A COFF object or executable.
4110 The exact description of these different formats is available in
4111 documentation from Microsoft.
4113 When @command{windres} converts from the @code{rc} format to the @code{res}
4114 format, it is acting like the Windows Resource Compiler. When
4115 @command{windres} converts from the @code{res} format to the @code{coff}
4116 format, it is acting like the Windows @code{CVTRES} program.
4118 When @command{windres} generates an @code{rc} file, the output is similar
4119 but not identical to the format expected for the input. When an input
4120 @code{rc} file refers to an external filename, an output @code{rc} file
4121 will instead include the file contents.
4123 If the input or output format is not specified, @command{windres} will
4124 guess based on the file name, or, for the input file, the file contents.
4125 A file with an extension of @file{.rc} will be treated as an @code{rc}
4126 file, a file with an extension of @file{.res} will be treated as a
4127 @code{res} file, and a file with an extension of @file{.o} or
4128 @file{.exe} will be treated as a @code{coff} file.
4130 If no output file is specified, @command{windres} will print the resources
4131 in @code{rc} format to standard output.
4133 The normal use is for you to write an @code{rc} file, use @command{windres}
4134 to convert it to a COFF object file, and then link the COFF file into
4135 your application. This will make the resources described in the
4136 @code{rc} file available to Windows.
4140 @c man begin OPTIONS windres
4143 @item -i @var{filename}
4144 @itemx --input @var{filename}
4145 The name of the input file. If this option is not used, then
4146 @command{windres} will use the first non-option argument as the input file
4147 name. If there are no non-option arguments, then @command{windres} will
4148 read from standard input. @command{windres} can not read a COFF file from
4151 @item -o @var{filename}
4152 @itemx --output @var{filename}
4153 The name of the output file. If this option is not used, then
4154 @command{windres} will use the first non-option argument, after any used
4155 for the input file name, as the output file name. If there is no
4156 non-option argument, then @command{windres} will write to standard output.
4157 @command{windres} can not write a COFF file to standard output. Note,
4158 for compatibility with @command{rc} the option @option{-fo} is also
4159 accepted, but its use is not recommended.
4161 @item -J @var{format}
4162 @itemx --input-format @var{format}
4163 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4164 @samp{coff}. If no input format is specified, @command{windres} will
4165 guess, as described above.
4167 @item -O @var{format}
4168 @itemx --output-format @var{format}
4169 The output format to generate. @var{format} may be @samp{res},
4170 @samp{rc}, or @samp{coff}. If no output format is specified,
4171 @command{windres} will guess, as described above.
4173 @item -F @var{target}
4174 @itemx --target @var{target}
4175 Specify the BFD format to use for a COFF file as input or output. This
4176 is a BFD target name; you can use the @option{--help} option to see a list
4177 of supported targets. Normally @command{windres} will use the default
4178 format, which is the first one listed by the @option{--help} option.
4180 @ref{Target Selection}.
4183 @item --preprocessor @var{program}
4184 When @command{windres} reads an @code{rc} file, it runs it through the C
4185 preprocessor first. This option may be used to specify the preprocessor
4186 to use, including any leading arguments. The default preprocessor
4187 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4189 @item --preprocessor-arg @var{option}
4190 When @command{windres} reads an @code{rc} file, it runs it through
4191 the C preprocessor first. This option may be used to specify additional
4192 text to be passed to preprocessor on its command line.
4193 This option can be used multiple times to add multiple options to the
4194 preprocessor command line.
4196 @item -I @var{directory}
4197 @itemx --include-dir @var{directory}
4198 Specify an include directory to use when reading an @code{rc} file.
4199 @command{windres} will pass this to the preprocessor as an @option{-I}
4200 option. @command{windres} will also search this directory when looking for
4201 files named in the @code{rc} file. If the argument passed to this command
4202 matches any of the supported @var{formats} (as described in the @option{-J}
4203 option), it will issue a deprecation warning, and behave just like the
4204 @option{-J} option. New programs should not use this behaviour. If a
4205 directory happens to match a @var{format}, simple prefix it with @samp{./}
4206 to disable the backward compatibility.
4208 @item -D @var{target}
4209 @itemx --define @var{sym}[=@var{val}]
4210 Specify a @option{-D} option to pass to the preprocessor when reading an
4213 @item -U @var{target}
4214 @itemx --undefine @var{sym}
4215 Specify a @option{-U} option to pass to the preprocessor when reading an
4219 Ignored for compatibility with rc.
4222 Enable verbose mode. This tells you what the preprocessor is if you
4226 @item --codepage @var{val}
4227 Specify the default codepage to use when reading an @code{rc} file.
4228 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4229 codepage code. The valid range is from zero up to 0xffff, but the
4230 validity of the codepage is host and configuration dependent.
4233 @item --language @var{val}
4234 Specify the default language to use when reading an @code{rc} file.
4235 @var{val} should be a hexadecimal language code. The low eight bits are
4236 the language, and the high eight bits are the sublanguage.
4238 @item --use-temp-file
4239 Use a temporary file to instead of using popen to read the output of
4240 the preprocessor. Use this option if the popen implementation is buggy
4241 on the host (eg., certain non-English language versions of Windows 95 and
4242 Windows 98 are known to have buggy popen where the output will instead
4245 @item --no-use-temp-file
4246 Use popen, not a temporary file, to read the output of the preprocessor.
4247 This is the default behaviour.
4251 Prints a usage summary.
4255 Prints the version number for @command{windres}.
4258 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4259 this will turn on parser debugging.
4265 @c man begin SEEALSO windres
4266 the Info entries for @file{binutils}.
4275 @command{dlltool} is used to create the files needed to create dynamic
4276 link libraries (DLLs) on systems which understand PE format image
4277 files such as Windows. A DLL contains an export table which contains
4278 information that the runtime loader needs to resolve references from a
4279 referencing program.
4281 The export table is generated by this program by reading in a
4282 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4283 will be in the DLL. A @file{.o} file can contain information in
4284 special @samp{.drectve} sections with export information.
4287 @emph{Note:} @command{dlltool} is not always built as part of the
4288 binary utilities, since it is only useful for those targets which
4292 @c man title dlltool create files needed to build and use DLLs
4295 @c man begin SYNOPSIS dlltool
4296 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4297 [@option{-b}|@option{--base-file} @var{base-file-name}]
4298 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4299 [@option{-z}|@option{--output-def} @var{def-file-name}]
4300 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4301 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4302 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4303 [@option{--exclude-symbols} @var{list}]
4304 [@option{--no-default-excludes}]
4305 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4306 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4307 [@option{-a}|@option{--add-indirect}]
4308 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4309 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4310 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4311 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4312 [@option{--use-nul-prefixed-import-tables}]
4313 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4314 [@option{-i}|@option{--interwork}]
4315 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4316 [@option{-v}|@option{--verbose}]
4317 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4318 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4319 [object-file @dots{}]
4323 @c man begin DESCRIPTION dlltool
4325 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4326 @option{-b} options as well as object files specified on the command
4327 line. It then processes these inputs and if the @option{-e} option has
4328 been specified it creates a exports file. If the @option{-l} option
4329 has been specified it creates a library file and if the @option{-z} option
4330 has been specified it creates a def file. Any or all of the @option{-e},
4331 @option{-l} and @option{-z} options can be present in one invocation of
4334 When creating a DLL, along with the source for the DLL, it is necessary
4335 to have three other files. @command{dlltool} can help with the creation of
4338 The first file is a @file{.def} file which specifies which functions are
4339 exported from the DLL, which functions the DLL imports, and so on. This
4340 is a text file and can be created by hand, or @command{dlltool} can be used
4341 to create it using the @option{-z} option. In this case @command{dlltool}
4342 will scan the object files specified on its command line looking for
4343 those functions which have been specially marked as being exported and
4344 put entries for them in the @file{.def} file it creates.
4346 In order to mark a function as being exported from a DLL, it needs to
4347 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4348 section of the object file. This can be done in C by using the
4352 asm (".section .drectve");
4353 asm (".ascii \"-export:my_func\"");
4355 int my_func (void) @{ @dots{} @}
4358 The second file needed for DLL creation is an exports file. This file
4359 is linked with the object files that make up the body of the DLL and it
4360 handles the interface between the DLL and the outside world. This is a
4361 binary file and it can be created by giving the @option{-e} option to
4362 @command{dlltool} when it is creating or reading in a @file{.def} file.
4364 The third file needed for DLL creation is the library file that programs
4365 will link with in order to access the functions in the DLL (an `import
4366 library'). This file can be created by giving the @option{-l} option to
4367 dlltool when it is creating or reading in a @file{.def} file.
4369 If the @option{-y} option is specified, dlltool generates a delay-import
4370 library that can be used instead of the normal import library to allow
4371 a program to link to the dll only as soon as an imported function is
4372 called for the first time. The resulting executable will need to be
4373 linked to the static delayimp library containing __delayLoadHelper2(),
4374 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4376 @command{dlltool} builds the library file by hand, but it builds the
4377 exports file by creating temporary files containing assembler statements
4378 and then assembling these. The @option{-S} command-line option can be
4379 used to specify the path to the assembler that dlltool will use,
4380 and the @option{-f} option can be used to pass specific flags to that
4381 assembler. The @option{-n} can be used to prevent dlltool from deleting
4382 these temporary assembler files when it is done, and if @option{-n} is
4383 specified twice then this will prevent dlltool from deleting the
4384 temporary object files it used to build the library.
4386 Here is an example of creating a DLL from a source file @samp{dll.c} and
4387 also creating a program (from an object file called @samp{program.o})
4392 dlltool -e exports.o -l dll.lib dll.o
4393 gcc dll.o exports.o -o dll.dll
4394 gcc program.o dll.lib -o program
4398 @command{dlltool} may also be used to query an existing import library
4399 to determine the name of the DLL to which it is associated. See the
4400 description of the @option{-I} or @option{--identify} option.
4404 @c man begin OPTIONS dlltool
4406 The command-line options have the following meanings:
4410 @item -d @var{filename}
4411 @itemx --input-def @var{filename}
4412 @cindex input .def file
4413 Specifies the name of a @file{.def} file to be read in and processed.
4415 @item -b @var{filename}
4416 @itemx --base-file @var{filename}
4418 Specifies the name of a base file to be read in and processed. The
4419 contents of this file will be added to the relocation section in the
4420 exports file generated by dlltool.
4422 @item -e @var{filename}
4423 @itemx --output-exp @var{filename}
4424 Specifies the name of the export file to be created by dlltool.
4426 @item -z @var{filename}
4427 @itemx --output-def @var{filename}
4428 Specifies the name of the @file{.def} file to be created by dlltool.
4430 @item -l @var{filename}
4431 @itemx --output-lib @var{filename}
4432 Specifies the name of the library file to be created by dlltool.
4434 @item -y @var{filename}
4435 @itemx --output-delaylib @var{filename}
4436 Specifies the name of the delay-import library file to be created by dlltool.
4438 @item --export-all-symbols
4439 Treat all global and weak defined symbols found in the input object
4440 files as symbols to be exported. There is a small list of symbols which
4441 are not exported by default; see the @option{--no-default-excludes}
4442 option. You may add to the list of symbols to not export by using the
4443 @option{--exclude-symbols} option.
4445 @item --no-export-all-symbols
4446 Only export symbols explicitly listed in an input @file{.def} file or in
4447 @samp{.drectve} sections in the input object files. This is the default
4448 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4449 attributes in the source code.
4451 @item --exclude-symbols @var{list}
4452 Do not export the symbols in @var{list}. This is a list of symbol names
4453 separated by comma or colon characters. The symbol names should not
4454 contain a leading underscore. This is only meaningful when
4455 @option{--export-all-symbols} is used.
4457 @item --no-default-excludes
4458 When @option{--export-all-symbols} is used, it will by default avoid
4459 exporting certain special symbols. The current list of symbols to avoid
4460 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4461 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4462 to go ahead and export these special symbols. This is only meaningful
4463 when @option{--export-all-symbols} is used.
4466 @itemx --as @var{path}
4467 Specifies the path, including the filename, of the assembler to be used
4468 to create the exports file.
4470 @item -f @var{options}
4471 @itemx --as-flags @var{options}
4472 Specifies any specific command-line options to be passed to the
4473 assembler when building the exports file. This option will work even if
4474 the @option{-S} option is not used. This option only takes one argument,
4475 and if it occurs more than once on the command line, then later
4476 occurrences will override earlier occurrences. So if it is necessary to
4477 pass multiple options to the assembler they should be enclosed in
4481 @itemx --dll-name @var{name}
4482 Specifies the name to be stored in the @file{.def} file as the name of
4483 the DLL when the @option{-e} option is used. If this option is not
4484 present, then the filename given to the @option{-e} option will be
4485 used as the name of the DLL.
4487 @item -m @var{machine}
4488 @itemx -machine @var{machine}
4489 Specifies the type of machine for which the library file should be
4490 built. @command{dlltool} has a built in default type, depending upon how
4491 it was created, but this option can be used to override that. This is
4492 normally only useful when creating DLLs for an ARM processor, when the
4493 contents of the DLL are actually encode using Thumb instructions.
4496 @itemx --add-indirect
4497 Specifies that when @command{dlltool} is creating the exports file it
4498 should add a section which allows the exported functions to be
4499 referenced without using the import library. Whatever the hell that
4503 @itemx --add-underscore
4504 Specifies that when @command{dlltool} is creating the exports file it
4505 should prepend an underscore to the names of @emph{all} exported symbols.
4507 @item --no-leading-underscore
4508 @item --leading-underscore
4509 Specifies whether standard symbol should be forced to be prefixed, or
4512 @item --add-stdcall-underscore
4513 Specifies that when @command{dlltool} is creating the exports file it
4514 should prepend an underscore to the names of exported @emph{stdcall}
4515 functions. Variable names and non-stdcall function names are not modified.
4516 This option is useful when creating GNU-compatible import libs for third
4517 party DLLs that were built with MS-Windows tools.
4521 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4522 of stdcall functions that will be imported from the DLL. This is
4523 useful when creating an import library for a DLL which exports stdcall
4524 functions but without the usual @samp{@@<number>} symbol name suffix.
4526 This does not change the naming of symbols provided by the import library
4527 to programs linked against it, but only the entries in the import table
4528 (ie the .idata section).
4531 @itemx --add-stdcall-alias
4532 Specifies that when @command{dlltool} is creating the exports file it
4533 should add aliases for stdcall symbols without @samp{@@ <number>}
4534 in addition to the symbols with @samp{@@ <number>}.
4537 @itemx --ext-prefix-alias @var{prefix}
4538 Causes @command{dlltool} to create external aliases for all DLL
4539 imports with the specified prefix. The aliases are created for both
4540 external and import symbols with no leading underscore.
4544 Specifies that when @command{dlltool} is creating the exports and library
4545 files it should omit the @code{.idata4} section. This is for compatibility
4546 with certain operating systems.
4548 @item --use-nul-prefixed-import-tables
4549 Specifies that when @command{dlltool} is creating the exports and library
4550 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4551 element. This emulates old gnu import library generation of
4552 @code{dlltool}. By default this option is turned off.
4556 Specifies that when @command{dlltool} is creating the exports and library
4557 files it should omit the @code{.idata5} section. This is for compatibility
4558 with certain operating systems.
4560 @item -I @var{filename}
4561 @itemx --identify @var{filename}
4562 Specifies that @command{dlltool} should inspect the import library
4563 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4564 of the associated DLL(s). This can be performed in addition to any
4565 other operations indicated by the other options and arguments.
4566 @command{dlltool} fails if the import library does not exist or is not
4567 actually an import library. See also @option{--identify-strict}.
4569 @item --identify-strict
4570 Modifies the behavior of the @option{--identify} option, such
4571 that an error is reported if @var{filename} is associated with
4576 Specifies that @command{dlltool} should mark the objects in the library
4577 file and exports file that it produces as supporting interworking
4578 between ARM and Thumb code.
4582 Makes @command{dlltool} preserve the temporary assembler files it used to
4583 create the exports file. If this option is repeated then dlltool will
4584 also preserve the temporary object files it uses to create the library
4587 @item -t @var{prefix}
4588 @itemx --temp-prefix @var{prefix}
4589 Makes @command{dlltool} use @var{prefix} when constructing the names of
4590 temporary assembler and object files. By default, the temp file prefix
4591 is generated from the pid.
4595 Make dlltool describe what it is doing.
4599 Displays a list of command-line options and then exits.
4603 Displays dlltool's version number and then exits.
4610 * def file format:: The format of the dlltool @file{.def} file
4613 @node def file format
4614 @section The format of the @command{dlltool} @file{.def} file
4616 A @file{.def} file contains any number of the following commands:
4620 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4621 The result is going to be named @var{name}@code{.exe}.
4623 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4624 The result is going to be named @var{name}@code{.dll}.
4625 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4626 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4629 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4630 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4631 Declares @var{name1} as an exported symbol from the DLL, with optional
4632 ordinal number @var{integer}, or declares @var{name1} as an alias
4633 (forward) of the function @var{external-name} in the DLL.
4634 If @var{its_name} is specified, this name is used as string in export table.
4636 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4637 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4638 If you want to use LIBRARY as name then you need to quote it.
4640 @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{]} *}
4641 Declares that @var{external-name} or the exported function whose
4642 ordinal number is @var{integer} is to be imported from the file
4643 @var{module-name}. If @var{internal-name} is specified then this is
4644 the name that the imported function will be referred to in the body of
4646 If @var{its_name} is specified, this name is used as string in import table.
4647 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4648 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4649 If you want to use LIBRARY as name then you need to quote it.
4651 @item @code{DESCRIPTION} @var{string}
4652 Puts @var{string} into the output @file{.exp} file in the
4653 @code{.rdata} section.
4655 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4656 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4657 Generates @code{--stack} or @code{--heap}
4658 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4659 section. The linker will see this and act upon it.
4661 @item @code{CODE} @var{attr} @code{+}
4662 @item @code{DATA} @var{attr} @code{+}
4663 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4664 Generates @code{--attr} @var{section-name} @var{attr} in the output
4665 @code{.drectve} section, where @var{attr} is one of @code{READ},
4666 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4667 this and act upon it.
4672 @c man begin SEEALSO dlltool
4673 The Info pages for @file{binutils}.
4680 @cindex ELF file information
4683 @c man title readelf display information about ELF files
4686 @c man begin SYNOPSIS readelf
4687 readelf [@option{-a}|@option{--all}]
4688 [@option{-h}|@option{--file-header}]
4689 [@option{-l}|@option{--program-headers}|@option{--segments}]
4690 [@option{-S}|@option{--section-headers}|@option{--sections}]
4691 [@option{-g}|@option{--section-groups}]
4692 [@option{-t}|@option{--section-details}]
4693 [@option{-e}|@option{--headers}]
4694 [@option{-s}|@option{--syms}|@option{--symbols}]
4695 [@option{--dyn-syms}]
4696 [@option{-n}|@option{--notes}]
4697 [@option{-r}|@option{--relocs}]
4698 [@option{-u}|@option{--unwind}]
4699 [@option{-d}|@option{--dynamic}]
4700 [@option{-V}|@option{--version-info}]
4701 [@option{-A}|@option{--arch-specific}]
4702 [@option{-D}|@option{--use-dynamic}]
4703 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4704 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4705 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4706 [@option{-z}|@option{--decompress}]
4707 [@option{-c}|@option{--archive-index}]
4708 [@option{-w[lLiaprmfFsoRtUuTgAckK]}|
4709 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
4710 [@option{--dwarf-depth=@var{n}}]
4711 [@option{--dwarf-start=@var{n}}]
4712 [@option{--ctf=}@var{section}]
4713 [@option{--ctf-parent=}@var{section}]
4714 [@option{--ctf-symbols=}@var{section}]
4715 [@option{--ctf-strings=}@var{section}]
4716 [@option{-I}|@option{--histogram}]
4717 [@option{-v}|@option{--version}]
4718 [@option{-W}|@option{--wide}]
4719 [@option{-H}|@option{--help}]
4720 @var{elffile}@dots{}
4724 @c man begin DESCRIPTION readelf
4726 @command{readelf} displays information about one or more ELF format object
4727 files. The options control what particular information to display.
4729 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4730 64-bit ELF files are supported, as are archives containing ELF files.
4732 This program performs a similar function to @command{objdump} but it
4733 goes into more detail and it exists independently of the @sc{bfd}
4734 library, so if there is a bug in @sc{bfd} then readelf will not be
4739 @c man begin OPTIONS readelf
4741 The long and short forms of options, shown here as alternatives, are
4742 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4748 Equivalent to specifying @option{--file-header},
4749 @option{--program-headers}, @option{--sections}, @option{--symbols},
4750 @option{--relocs}, @option{--dynamic}, @option{--notes},
4751 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
4752 @option{--section-groups} and @option{--histogram}.
4754 Note - this option does not enable @option{--use-dynamic} itself, so
4755 if that option is not present on the command line then dynamic symbols
4756 and dynamic relocs will not be displayed.
4759 @itemx --file-header
4760 @cindex ELF file header information
4761 Displays the information contained in the ELF header at the start of the
4765 @itemx --program-headers
4767 @cindex ELF program header information
4768 @cindex ELF segment information
4769 Displays the information contained in the file's segment headers, if it
4774 @itemx --section-headers
4775 @cindex ELF section information
4776 Displays the information contained in the file's section headers, if it
4780 @itemx --section-groups
4781 @cindex ELF section group information
4782 Displays the information contained in the file's section groups, if it
4786 @itemx --section-details
4787 @cindex ELF section information
4788 Displays the detailed section information. Implies @option{-S}.
4793 @cindex ELF symbol table information
4794 Displays the entries in symbol table section of the file, if it has one.
4795 If a symbol has version information associated with it then this is
4796 displayed as well. The version string is displayed as a suffix to the
4797 symbol name, preceeded by an @@ character. For example
4798 @samp{foo@@VER_1}. If the version is the default version to be used
4799 when resolving unversioned references to the symbol then it is
4800 displayed as a suffix preceeded by two @@ characters. For example
4801 @samp{foo@@@@VER_2}.
4804 @cindex ELF dynamic symbol table information
4805 Displays the entries in dynamic symbol table section of the file, if it
4806 has one. The output format is the same as the format used by the
4807 @option{--syms} option.
4811 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4816 Displays the contents of the NOTE segments and/or sections, if any.
4820 @cindex ELF reloc information
4821 Displays the contents of the file's relocation section, if it has one.
4825 @cindex unwind information
4826 Displays the contents of the file's unwind section, if it has one. Only
4827 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4828 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. If
4829 support is not yet implemented for your architecture you could try
4830 dumping the contents of the @var{.eh_frames} section using the
4831 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
4836 @cindex ELF dynamic section information
4837 Displays the contents of the file's dynamic section, if it has one.
4840 @itemx --version-info
4841 @cindex ELF version sections information
4842 Displays the contents of the version sections in the file, it they
4846 @itemx --arch-specific
4847 Displays architecture-specific information in the file, if there
4851 @itemx --use-dynamic
4852 When displaying symbols, this option makes @command{readelf} use the
4853 symbol hash tables in the file's dynamic section, rather than the
4854 symbol table sections.
4856 When displaying relocations, this option makes @command{readelf}
4857 display the dynamic relocations rather than the static relocations.
4859 @item -x <number or name>
4860 @itemx --hex-dump=<number or name>
4861 Displays the contents of the indicated section as a hexadecimal bytes.
4862 A number identifies a particular section by index in the section table;
4863 any other string identifies all sections with that name in the object file.
4865 @item -R <number or name>
4866 @itemx --relocated-dump=<number or name>
4867 Displays the contents of the indicated section as a hexadecimal
4868 bytes. A number identifies a particular section by index in the
4869 section table; any other string identifies all sections with that name
4870 in the object file. The contents of the section will be relocated
4871 before they are displayed.
4873 @item -p <number or name>
4874 @itemx --string-dump=<number or name>
4875 Displays the contents of the indicated section as printable strings.
4876 A number identifies a particular section by index in the section table;
4877 any other string identifies all sections with that name in the object file.
4881 Requests that the section(s) being dumped by @option{x}, @option{R} or
4882 @option{p} options are decompressed before being displayed. If the
4883 section(s) are not compressed then they are displayed as is.
4886 @itemx --archive-index
4887 @cindex Archive file symbol index information
4888 Displays the file symbol index information contained in the header part
4889 of binary archives. Performs the same function as the @option{t}
4890 command to @command{ar}, but without using the BFD library. @xref{ar}.
4892 @item -w[lLiaprmfFsoRtUuTgAckK]
4893 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
4894 @include debug.options.texi
4896 @include ctf.options.texi
4897 @item --ctf-symbols=@var{section}
4898 @item --ctf-strings=@var{section}
4899 Specify the name of another section from which the CTF file can inherit
4900 strings and symbols. By default, the @code{.symtab} and its linked
4901 string table are used.
4903 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
4904 other must be specified as well.
4908 Display a histogram of bucket list lengths when displaying the contents
4909 of the symbol tables.
4913 Display the version number of readelf.
4917 Don't break output lines to fit into 80 columns. By default
4918 @command{readelf} breaks section header and segment listing lines for
4919 64-bit ELF files, so that they fit into 80 columns. This option causes
4920 @command{readelf} to print each section header resp. each segment one a
4921 single line, which is far more readable on terminals wider than 80 columns.
4925 Display the command-line options understood by @command{readelf}.
4932 @c man begin SEEALSO readelf
4933 objdump(1), and the Info entries for @file{binutils}.
4940 @cindex Update ELF header
4943 @c man title elfedit update ELF header and program property of ELF files
4946 @c man begin SYNOPSIS elfedit
4947 elfedit [@option{--input-mach=}@var{machine}]
4948 [@option{--input-type=}@var{type}]
4949 [@option{--input-osabi=}@var{osabi}]
4950 @option{--output-mach=}@var{machine}
4951 @option{--output-type=}@var{type}
4952 @option{--output-osabi=}@var{osabi}
4953 @option{--enable-x86-feature=}@var{feature}
4954 @option{--disable-x86-feature=}@var{feature}
4955 [@option{-v}|@option{--version}]
4956 [@option{-h}|@option{--help}]
4957 @var{elffile}@dots{}
4961 @c man begin DESCRIPTION elfedit
4963 @command{elfedit} updates the ELF header and program property of ELF
4964 files which have the matching ELF machine and file types. The options
4965 control how and which fields in the ELF header and program property
4968 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4969 64-bit ELF files are supported, as are archives containing ELF files.
4972 @c man begin OPTIONS elfedit
4974 The long and short forms of options, shown here as alternatives, are
4975 equivalent. At least one of the @option{--output-mach},
4976 @option{--output-type}, @option{--output-osabi},
4977 @option{--enable-x86-feature} and @option{--disable-x86-feature}
4978 options must be given.
4982 @item --input-mach=@var{machine}
4983 Set the matching input ELF machine type to @var{machine}. If
4984 @option{--input-mach} isn't specified, it will match any ELF
4987 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4988 @var{K1OM} and @var{x86-64}.
4990 @item --output-mach=@var{machine}
4991 Change the ELF machine type in the ELF header to @var{machine}. The
4992 supported ELF machine types are the same as @option{--input-mach}.
4994 @item --input-type=@var{type}
4995 Set the matching input ELF file type to @var{type}. If
4996 @option{--input-type} isn't specified, it will match any ELF file types.
4998 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
5000 @item --output-type=@var{type}
5001 Change the ELF file type in the ELF header to @var{type}. The
5002 supported ELF types are the same as @option{--input-type}.
5004 @item --input-osabi=@var{osabi}
5005 Set the matching input ELF file OSABI to @var{osabi}. If
5006 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
5008 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
5009 @var{GNU}, @var{Linux} (alias for @var{GNU}),
5010 @var{Solaris}, @var{AIX}, @var{Irix},
5011 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
5012 @var{NSK}, @var{AROS} and @var{FenixOS}.
5014 @item --output-osabi=@var{osabi}
5015 Change the ELF OSABI in the ELF header to @var{osabi}. The
5016 supported ELF OSABI are the same as @option{--input-osabi}.
5018 @item --enable-x86-feature=@var{feature}
5019 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
5020 ELF files with machine types of @var{i386} or @var{x86-64}. The
5021 supported features are, @var{ibt} and @var{shstk}.
5023 @item --disable-x86-feature=@var{feature}
5024 Clear the @var{feature} bit in program property in @var{exec} or
5025 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
5026 The supported features are the same as @option{--enable-x86-feature}.
5028 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
5029 are available only on hosts with @samp{mmap} support.
5033 Display the version number of @command{elfedit}.
5037 Display the command-line options understood by @command{elfedit}.
5044 @c man begin SEEALSO elfedit
5045 readelf(1), and the Info entries for @file{binutils}.
5049 @node Common Options
5050 @chapter Common Options
5052 The following command-line options are supported by all of the
5053 programs described in this manual.
5055 @c man begin OPTIONS
5057 @include at-file.texi
5061 Display the command-line options supported by the program.
5064 Display the version number of the program.
5066 @c man begin OPTIONS
5070 @node Selecting the Target System
5071 @chapter Selecting the Target System
5073 You can specify two aspects of the target system to the @sc{gnu}
5074 binary file utilities, each in several ways:
5084 In the following summaries, the lists of ways to specify values are in
5085 order of decreasing precedence. The ways listed first override those
5088 The commands to list valid values only list the values for which the
5089 programs you are running were configured. If they were configured with
5090 @option{--enable-targets=all}, the commands list most of the available
5091 values, but a few are left out; not all targets can be configured in at
5092 once because some of them can only be configured @dfn{native} (on hosts
5093 with the same type as the target system).
5096 * Target Selection::
5097 * Architecture Selection::
5100 @node Target Selection
5101 @section Target Selection
5103 A @dfn{target} is an object file format. A given target may be
5104 supported for multiple architectures (@pxref{Architecture Selection}).
5105 A target selection may also have variations for different operating
5106 systems or architectures.
5108 The command to list valid target values is @samp{objdump -i}
5109 (the first column of output contains the relevant information).
5111 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5112 @samp{a.out-sunos-big}.
5114 You can also specify a target using a configuration triplet. This is
5115 the same sort of name that is passed to @file{configure} to specify a
5116 target. When you use a configuration triplet as an argument, it must be
5117 fully canonicalized. You can see the canonical version of a triplet by
5118 running the shell script @file{config.sub} which is included with the
5121 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5122 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5124 @subheading @command{objdump} Target
5130 command-line option: @option{-b} or @option{--target}
5133 environment variable @code{GNUTARGET}
5136 deduced from the input file
5139 @subheading @command{objcopy} and @command{strip} Input Target
5145 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5148 environment variable @code{GNUTARGET}
5151 deduced from the input file
5154 @subheading @command{objcopy} and @command{strip} Output Target
5160 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5163 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5166 environment variable @code{GNUTARGET}
5169 deduced from the input file
5172 @subheading @command{nm}, @command{size}, and @command{strings} Target
5178 command-line option: @option{--target}
5181 environment variable @code{GNUTARGET}
5184 deduced from the input file
5187 @node Architecture Selection
5188 @section Architecture Selection
5190 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5191 to run. Its name may contain a colon, separating the name of the
5192 processor family from the name of the particular @sc{cpu}.
5194 The command to list valid architecture values is @samp{objdump -i} (the
5195 second column contains the relevant information).
5197 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5199 @subheading @command{objdump} Architecture
5205 command-line option: @option{-m} or @option{--architecture}
5208 deduced from the input file
5211 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5217 deduced from the input file
5222 @cindex separate debug files
5224 debuginfod is a web service that indexes ELF/DWARF debugging resources
5225 by build-id and serves them over HTTP.
5227 Binutils can be built with the debuginfod client library
5228 @code{libdebuginfod} using the @option{--with-debuginfod} configure option.
5229 This option is enabled by default if @code{libdebuginfod} is installed
5230 and found at configure time. This allows @command{objdump} and
5231 @command{readelf} to automatically query debuginfod servers for
5232 separate debug files when the files are otherwise not found.
5234 debuginfod is packaged with elfutils, starting with version 0.178.
5235 You can get the latest version from `https://sourceware.org/elfutils/'.
5237 @node Reporting Bugs
5238 @chapter Reporting Bugs
5240 @cindex reporting bugs
5242 Your bug reports play an essential role in making the binary utilities
5245 Reporting a bug may help you by bringing a solution to your problem, or
5246 it may not. But in any case the principal function of a bug report is
5247 to help the entire community by making the next version of the binary
5248 utilities work better. Bug reports are your contribution to their
5251 In order for a bug report to serve its purpose, you must include the
5252 information that enables us to fix the bug.
5255 * Bug Criteria:: Have you found a bug?
5256 * Bug Reporting:: How to report bugs
5260 @section Have You Found a Bug?
5261 @cindex bug criteria
5263 If you are not sure whether you have found a bug, here are some guidelines:
5266 @cindex fatal signal
5269 If a binary utility gets a fatal signal, for any input whatever, that is
5270 a bug. Reliable utilities never crash.
5272 @cindex error on valid input
5274 If a binary utility produces an error message for valid input, that is a
5278 If you are an experienced user of binary utilities, your suggestions for
5279 improvement are welcome in any case.
5283 @section How to Report Bugs
5285 @cindex bugs, reporting
5287 A number of companies and individuals offer support for @sc{gnu}
5288 products. If you obtained the binary utilities from a support
5289 organization, we recommend you contact that organization first.
5291 You can find contact information for many support companies and
5292 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5296 In any event, we also recommend that you send bug reports for the binary
5297 utilities to @value{BUGURL}.
5300 The fundamental principle of reporting bugs usefully is this:
5301 @strong{report all the facts}. If you are not sure whether to state a
5302 fact or leave it out, state it!
5304 Often people omit facts because they think they know what causes the
5305 problem and assume that some details do not matter. Thus, you might
5306 assume that the name of a file you use in an example does not matter.
5307 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5308 a stray memory reference which happens to fetch from the location where
5309 that pathname is stored in memory; perhaps, if the pathname were
5310 different, the contents of that location would fool the utility into
5311 doing the right thing despite the bug. Play it safe and give a
5312 specific, complete example. That is the easiest thing for you to do,
5313 and the most helpful.
5315 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5316 it is new to us. Therefore, always write your bug reports on the assumption
5317 that the bug has not been reported previously.
5319 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5320 bell?'' This cannot help us fix a bug, so it is basically useless. We
5321 respond by asking for enough details to enable us to investigate.
5322 You might as well expedite matters by sending them to begin with.
5324 To enable us to fix the bug, you should include all these things:
5328 The version of the utility. Each utility announces it if you start it
5329 with the @option{--version} argument.
5331 Without this, we will not know whether there is any point in looking for
5332 the bug in the current version of the binary utilities.
5335 Any patches you may have applied to the source, including any patches
5336 made to the @code{BFD} library.
5339 The type of machine you are using, and the operating system name and
5343 What compiler (and its version) was used to compile the utilities---e.g.
5347 The command arguments you gave the utility to observe the bug. To
5348 guarantee you will not omit something important, list them all. A copy
5349 of the Makefile (or the output from make) is sufficient.
5351 If we were to try to guess the arguments, we would probably guess wrong
5352 and then we might not encounter the bug.
5355 A complete input file, or set of input files, that will reproduce the
5356 bug. If the utility is reading an object file or files, then it is
5357 generally most helpful to send the actual object files.
5359 If the source files were produced exclusively using @sc{gnu} programs
5360 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5361 may be OK to send the source files rather than the object files. In
5362 this case, be sure to say exactly what version of @command{gcc}, or
5363 whatever, was used to produce the object files. Also say how
5364 @command{gcc}, or whatever, was configured.
5367 A description of what behavior you observe that you believe is
5368 incorrect. For example, ``It gets a fatal signal.''
5370 Of course, if the bug is that the utility gets a fatal signal, then we
5371 will certainly notice it. But if the bug is incorrect output, we might
5372 not notice unless it is glaringly wrong. You might as well not give us
5373 a chance to make a mistake.
5375 Even if the problem you experience is a fatal signal, you should still
5376 say so explicitly. Suppose something strange is going on, such as your
5377 copy of the utility is out of sync, or you have encountered a bug in
5378 the C library on your system. (This has happened!) Your copy might
5379 crash and ours would not. If you told us to expect a crash, then when
5380 ours fails to crash, we would know that the bug was not happening for
5381 us. If you had not told us to expect a crash, then we would not be able
5382 to draw any conclusion from our observations.
5385 If you wish to suggest changes to the source, send us context diffs, as
5386 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5387 option. Always send diffs from the old file to the new file. If you
5388 wish to discuss something in the @command{ld} source, refer to it by
5389 context, not by line number.
5391 The line numbers in our development sources will not match those in your
5392 sources. Your line numbers would convey no useful information to us.
5395 Here are some things that are not necessary:
5399 A description of the envelope of the bug.
5401 Often people who encounter a bug spend a lot of time investigating
5402 which changes to the input file will make the bug go away and which
5403 changes will not affect it.
5405 This is often time consuming and not very useful, because the way we
5406 will find the bug is by running a single example under the debugger
5407 with breakpoints, not by pure deduction from a series of examples.
5408 We recommend that you save your time for something else.
5410 Of course, if you can find a simpler example to report @emph{instead}
5411 of the original one, that is a convenience for us. Errors in the
5412 output will be easier to spot, running under the debugger will take
5413 less time, and so on.
5415 However, simplification is not vital; if you do not want to do this,
5416 report the bug anyway and send us the entire test case you used.
5419 A patch for the bug.
5421 A patch for the bug does help us if it is a good one. But do not omit
5422 the necessary information, such as the test case, on the assumption that
5423 a patch is all we need. We might see problems with your patch and decide
5424 to fix the problem another way, or we might not understand it at all.
5426 Sometimes with programs as complicated as the binary utilities it is
5427 very hard to construct an example that will make the program follow a
5428 certain path through the code. If you do not send us the example, we
5429 will not be able to construct one, so we will not be able to verify that
5432 And if we cannot understand what bug you are trying to fix, or why your
5433 patch should be an improvement, we will not install it. A test case will
5434 help us to understand.
5437 A guess about what the bug is or what it depends on.
5439 Such guesses are usually wrong. Even we cannot guess right about such
5440 things without first using the debugger to find the facts.
5443 @node GNU Free Documentation License
5444 @appendix GNU Free Documentation License
5448 @node Binutils Index
5449 @unnumbered Binutils Index