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 (also known as the entry address) of the new
1572 file to @var{val}. Not all object file formats support setting the
1575 @item --change-start @var{incr}
1576 @itemx --adjust-start @var{incr}
1577 @cindex changing start address
1578 Change the start address (also known as the entry address) by adding
1579 @var{incr}. Not all object file formats support setting the start
1582 @item --change-addresses @var{incr}
1583 @itemx --adjust-vma @var{incr}
1584 @cindex changing object addresses
1585 Change the VMA and LMA addresses of all sections, as well as the start
1586 address, by adding @var{incr}. Some object file formats do not permit
1587 section addresses to be changed arbitrarily. Note that this does not
1588 relocate the sections; if the program expects sections to be loaded at a
1589 certain address, and this option is used to change the sections such
1590 that they are loaded at a different address, the program may fail.
1592 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1593 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1594 @cindex changing section address
1595 Set or change both the VMA address and the LMA address of any section
1596 matching @var{sectionpattern}. If @samp{=} is used, the section
1597 address is set to @var{val}. Otherwise, @var{val} is added to or
1598 subtracted from the section address. See the comments under
1599 @option{--change-addresses}, above. If @var{sectionpattern} does not
1600 match any sections in the input file, a warning will be issued, unless
1601 @option{--no-change-warnings} is used.
1603 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1604 @cindex changing section LMA
1605 Set or change the LMA address of any sections matching
1606 @var{sectionpattern}. The LMA address is the address where the
1607 section will be loaded into memory at program load time. Normally
1608 this is the same as the VMA address, which is the address of the
1609 section at program run time, but on some systems, especially those
1610 where a program is held in ROM, the two can be different. If @samp{=}
1611 is used, the section address is set to @var{val}. Otherwise,
1612 @var{val} is added to or subtracted from the section address. See the
1613 comments under @option{--change-addresses}, above. If
1614 @var{sectionpattern} does not match any sections in the input file, a
1615 warning will be issued, unless @option{--no-change-warnings} is used.
1617 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1618 @cindex changing section VMA
1619 Set or change the VMA address of any section matching
1620 @var{sectionpattern}. The VMA address is the address where the
1621 section will be located once the program has started executing.
1622 Normally this is the same as the LMA address, which is the address
1623 where the section will be loaded into memory, but on some systems,
1624 especially those where a program is held in ROM, the two can be
1625 different. If @samp{=} is used, the section address is set to
1626 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1627 section address. See the comments under @option{--change-addresses},
1628 above. If @var{sectionpattern} does not match any sections in the
1629 input file, a warning will be issued, unless
1630 @option{--no-change-warnings} is used.
1632 @item --change-warnings
1633 @itemx --adjust-warnings
1634 If @option{--change-section-address} or @option{--change-section-lma} or
1635 @option{--change-section-vma} is used, and the section pattern does not
1636 match any sections, issue a warning. This is the default.
1638 @item --no-change-warnings
1639 @itemx --no-adjust-warnings
1640 Do not issue a warning if @option{--change-section-address} or
1641 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1642 if the section pattern does not match any sections.
1644 @item --set-section-flags @var{sectionpattern}=@var{flags}
1645 Set the flags for any sections matching @var{sectionpattern}. The
1646 @var{flags} argument is a comma separated string of flag names. The
1647 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1648 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1649 @samp{exclude}, @samp{share}, and @samp{debug}. You can set the
1650 @samp{contents} flag for a section which does not have contents, but it
1651 is not meaningful to clear the @samp{contents} flag of a section which
1652 does have contents--just remove the section instead. Not all flags are
1653 meaningful for all object file formats. In particular the
1654 @samp{share} flag is only meaningful for COFF format files and not for
1657 @item --set-section-alignment @var{sectionpattern}=@var{align}
1658 Set the alignment for any sections matching @var{sectionpattern}.
1659 @var{align} specifies the alignment in bytes and must be a power of
1660 two, i.e. 1, 2, 4, 8@dots{}.
1662 @item --add-section @var{sectionname}=@var{filename}
1663 Add a new section named @var{sectionname} while copying the file. The
1664 contents of the new section are taken from the file @var{filename}. The
1665 size of the section will be the size of the file. This option only
1666 works on file formats which can support sections with arbitrary names.
1667 Note - it may be necessary to use the @option{--set-section-flags}
1668 option to set the attributes of the newly created section.
1670 @item --dump-section @var{sectionname}=@var{filename}
1671 Place the contents of section named @var{sectionname} into the file
1672 @var{filename}, overwriting any contents that may have been there
1673 previously. This option is the inverse of @option{--add-section}.
1674 This option is similar to the @option{--only-section} option except
1675 that it does not create a formatted file, it just dumps the contents
1676 as raw binary data, without applying any relocations. The option can
1677 be specified more than once.
1679 @item --update-section @var{sectionname}=@var{filename}
1680 Replace the existing contents of a section named @var{sectionname}
1681 with the contents of file @var{filename}. The size of the section
1682 will be adjusted to the size of the file. The section flags for
1683 @var{sectionname} will be unchanged. For ELF format files the section
1684 to segment mapping will also remain unchanged, something which is not
1685 possible using @option{--remove-section} followed by
1686 @option{--add-section}. The option can be specified more than once.
1688 Note - it is possible to use @option{--rename-section} and
1689 @option{--update-section} to both update and rename a section from one
1690 command line. In this case, pass the original section name to
1691 @option{--update-section}, and the original and new section names to
1692 @option{--rename-section}.
1694 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1695 Add a new symbol named @var{name} while copying the file. This option may be
1696 specified multiple times. If the @var{section} is given, the symbol will be
1697 associated with and relative to that section, otherwise it will be an ABS
1698 symbol. Specifying an undefined section will result in a fatal error. There
1699 is no check for the value, it will be taken as specified. Symbol flags can
1700 be specified and not all flags will be meaningful for all object file
1701 formats. By default, the symbol will be global. The special flag
1702 'before=@var{othersym}' will insert the new symbol in front of the specified
1703 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1704 symbol table in the order they appear.
1706 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1707 Rename a section from @var{oldname} to @var{newname}, optionally
1708 changing the section's flags to @var{flags} in the process. This has
1709 the advantage over using a linker script to perform the rename in that
1710 the output stays as an object file and does not become a linked
1711 executable. This option accepts the same set of flags as the
1712 @option{--sect-section-flags} option.
1714 This option is particularly helpful when the input format is binary,
1715 since this will always create a section called .data. If for example,
1716 you wanted instead to create a section called .rodata containing binary
1717 data you could use the following command line to achieve it:
1720 objcopy -I binary -O <output_format> -B <architecture> \
1721 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1722 <input_binary_file> <output_object_file>
1725 @item --long-section-names @{enable,disable,keep@}
1726 Controls the handling of long section names when processing @code{COFF}
1727 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1728 is to preserve long section names if any are present in the input file.
1729 The @samp{enable} and @samp{disable} options forcibly enable or disable
1730 the use of long section names in the output object; when @samp{disable}
1731 is in effect, any long section names in the input object will be truncated.
1732 The @samp{enable} option will only emit long section names if any are
1733 present in the inputs; this is mostly the same as @samp{keep}, but it
1734 is left undefined whether the @samp{enable} option might force the
1735 creation of an empty string table in the output file.
1737 @item --change-leading-char
1738 Some object file formats use special characters at the start of
1739 symbols. The most common such character is underscore, which compilers
1740 often add before every symbol. This option tells @command{objcopy} to
1741 change the leading character of every symbol when it converts between
1742 object file formats. If the object file formats use the same leading
1743 character, this option has no effect. Otherwise, it will add a
1744 character, or remove a character, or change a character, as
1747 @item --remove-leading-char
1748 If the first character of a global symbol is a special symbol leading
1749 character used by the object file format, remove the character. The
1750 most common symbol leading character is underscore. This option will
1751 remove a leading underscore from all global symbols. This can be useful
1752 if you want to link together objects of different file formats with
1753 different conventions for symbol names. This is different from
1754 @option{--change-leading-char} because it always changes the symbol name
1755 when appropriate, regardless of the object file format of the output
1758 @item --reverse-bytes=@var{num}
1759 Reverse the bytes in a section with output contents. A section length must
1760 be evenly divisible by the value given in order for the swap to be able to
1761 take place. Reversing takes place before the interleaving is performed.
1763 This option is used typically in generating ROM images for problematic
1764 target systems. For example, on some target boards, the 32-bit words
1765 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1766 regardless of the CPU byte order. Depending on the programming model, the
1767 endianness of the ROM may need to be modified.
1769 Consider a simple file with a section containing the following eight
1770 bytes: @code{12345678}.
1772 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1773 output file would be ordered @code{21436587}.
1775 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1776 output file would be ordered @code{43218765}.
1778 By using @samp{--reverse-bytes=2} for the above example, followed by
1779 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1780 output file would be ordered @code{34127856}.
1782 @item --srec-len=@var{ival}
1783 Meaningful only for srec output. Set the maximum length of the Srecords
1784 being produced to @var{ival}. This length covers both address, data and
1787 @item --srec-forceS3
1788 Meaningful only for srec output. Avoid generation of S1/S2 records,
1789 creating S3-only record format.
1791 @item --redefine-sym @var{old}=@var{new}
1792 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1793 when one is trying link two things together for which you have no
1794 source, and there are name collisions.
1796 @item --redefine-syms=@var{filename}
1797 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1798 listed in the file @var{filename}. @var{filename} is simply a flat file,
1799 with one symbol pair per line. Line comments may be introduced by the hash
1800 character. This option may be given more than once.
1803 Change all global symbols in the file to be weak. This can be useful
1804 when building an object which will be linked against other objects using
1805 the @option{-R} option to the linker. This option is only effective when
1806 using an object file format which supports weak symbols.
1808 @item --keep-symbols=@var{filename}
1809 Apply @option{--keep-symbol} option to each symbol listed in the file
1810 @var{filename}. @var{filename} is simply a flat file, with one symbol
1811 name per line. Line comments may be introduced by the hash character.
1812 This option may be given more than once.
1814 @item --strip-symbols=@var{filename}
1815 Apply @option{--strip-symbol} option to each symbol listed in the file
1816 @var{filename}. @var{filename} is simply a flat file, with one symbol
1817 name per line. Line comments may be introduced by the hash character.
1818 This option may be given more than once.
1820 @item --strip-unneeded-symbols=@var{filename}
1821 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1822 the file @var{filename}. @var{filename} is simply a flat file, with one
1823 symbol name per line. Line comments may be introduced by the hash
1824 character. This option may be given more than once.
1826 @item --keep-global-symbols=@var{filename}
1827 Apply @option{--keep-global-symbol} option to each symbol listed in the
1828 file @var{filename}. @var{filename} is simply a flat file, with one
1829 symbol name per line. Line comments may be introduced by the hash
1830 character. This option may be given more than once.
1832 @item --localize-symbols=@var{filename}
1833 Apply @option{--localize-symbol} option to each symbol listed in the file
1834 @var{filename}. @var{filename} is simply a flat file, with one symbol
1835 name per line. Line comments may be introduced by the hash character.
1836 This option may be given more than once.
1838 @item --globalize-symbols=@var{filename}
1839 Apply @option{--globalize-symbol} option to each symbol listed in the file
1840 @var{filename}. @var{filename} is simply a flat file, with one symbol
1841 name per line. Line comments may be introduced by the hash character.
1842 This option may be given more than once. Note: this option cannot be
1843 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1846 @item --weaken-symbols=@var{filename}
1847 Apply @option{--weaken-symbol} option to each symbol listed in the file
1848 @var{filename}. @var{filename} is simply a flat file, with one symbol
1849 name per line. Line comments may be introduced by the hash character.
1850 This option may be given more than once.
1852 @item --alt-machine-code=@var{index}
1853 If the output architecture has alternate machine codes, use the
1854 @var{index}th code instead of the default one. This is useful in case
1855 a machine is assigned an official code and the tool-chain adopts the
1856 new code, but other applications still depend on the original code
1857 being used. For ELF based architectures if the @var{index}
1858 alternative does not exist then the value is treated as an absolute
1859 number to be stored in the e_machine field of the ELF header.
1861 @item --writable-text
1862 Mark the output text as writable. This option isn't meaningful for all
1863 object file formats.
1865 @item --readonly-text
1866 Make the output text write protected. This option isn't meaningful for all
1867 object file formats.
1870 Mark the output file as demand paged. This option isn't meaningful for all
1871 object file formats.
1874 Mark the output file as impure. This option isn't meaningful for all
1875 object file formats.
1877 @item --prefix-symbols=@var{string}
1878 Prefix all symbols in the output file with @var{string}.
1880 @item --prefix-sections=@var{string}
1881 Prefix all section names in the output file with @var{string}.
1883 @item --prefix-alloc-sections=@var{string}
1884 Prefix all the names of all allocated sections in the output file with
1887 @item --add-gnu-debuglink=@var{path-to-file}
1888 Creates a .gnu_debuglink section which contains a reference to
1889 @var{path-to-file} and adds it to the output file. Note: the file at
1890 @var{path-to-file} must exist. Part of the process of adding the
1891 .gnu_debuglink section involves embedding a checksum of the contents
1892 of the debug info file into the section.
1894 If the debug info file is built in one location but it is going to be
1895 installed at a later time into a different location then do not use
1896 the path to the installed location. The @option{--add-gnu-debuglink}
1897 option will fail because the installed file does not exist yet.
1898 Instead put the debug info file in the current directory and use the
1899 @option{--add-gnu-debuglink} option without any directory components,
1903 objcopy --add-gnu-debuglink=foo.debug
1906 At debug time the debugger will attempt to look for the separate debug
1907 info file in a set of known locations. The exact set of these
1908 locations varies depending upon the distribution being used, but it
1913 @item * The same directory as the executable.
1915 @item * A sub-directory of the directory containing the executable
1918 @item * A global debug directory such as /usr/lib/debug.
1921 As long as the debug info file has been installed into one of these
1922 locations before the debugger is run everything should work
1925 @item --keep-file-symbols
1926 When stripping a file, perhaps with @option{--strip-debug} or
1927 @option{--strip-unneeded}, retain any symbols specifying source file names,
1928 which would otherwise get stripped.
1930 @item --only-keep-debug
1931 Strip a file, removing contents of any sections that would not be
1932 stripped by @option{--strip-debug} and leaving the debugging sections
1933 intact. In ELF files, this preserves all note sections in the output.
1935 Note - the section headers of the stripped sections are preserved,
1936 including their sizes, but the contents of the section are discarded.
1937 The section headers are preserved so that other tools can match up the
1938 debuginfo file with the real executable, even if that executable has
1939 been relocated to a different address space.
1941 The intention is that this option will be used in conjunction with
1942 @option{--add-gnu-debuglink} to create a two part executable. One a
1943 stripped binary which will occupy less space in RAM and in a
1944 distribution and the second a debugging information file which is only
1945 needed if debugging abilities are required. The suggested procedure
1946 to create these files is as follows:
1949 @item Link the executable as normal. Assuming that it is called
1951 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1952 create a file containing the debugging info.
1953 @item Run @code{objcopy --strip-debug foo} to create a
1954 stripped executable.
1955 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1956 to add a link to the debugging info into the stripped executable.
1959 Note---the choice of @code{.dbg} as an extension for the debug info
1960 file is arbitrary. Also the @code{--only-keep-debug} step is
1961 optional. You could instead do this:
1964 @item Link the executable as normal.
1965 @item Copy @code{foo} to @code{foo.full}
1966 @item Run @code{objcopy --strip-debug foo}
1967 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1970 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1971 full executable. It does not have to be a file created by the
1972 @option{--only-keep-debug} switch.
1974 Note---this switch is only intended for use on fully linked files. It
1975 does not make sense to use it on object files where the debugging
1976 information may be incomplete. Besides the gnu_debuglink feature
1977 currently only supports the presence of one filename containing
1978 debugging information, not multiple filenames on a one-per-object-file
1982 Remove the contents of all DWARF .dwo sections, leaving the
1983 remaining debugging sections and all symbols intact.
1984 This option is intended for use by the compiler as part of
1985 the @option{-gsplit-dwarf} option, which splits debug information
1986 between the .o file and a separate .dwo file. The compiler
1987 generates all debug information in the same file, then uses
1988 the @option{--extract-dwo} option to copy the .dwo sections to
1989 the .dwo file, then the @option{--strip-dwo} option to remove
1990 those sections from the original .o file.
1993 Extract the contents of all DWARF .dwo sections. See the
1994 @option{--strip-dwo} option for more information.
1996 @item --file-alignment @var{num}
1997 Specify the file alignment. Sections in the file will always begin at
1998 file offsets which are multiples of this number. This defaults to
2000 [This option is specific to PE targets.]
2002 @item --heap @var{reserve}
2003 @itemx --heap @var{reserve},@var{commit}
2004 Specify the number of bytes of memory to reserve (and optionally commit)
2005 to be used as heap for this program.
2006 [This option is specific to PE targets.]
2008 @item --image-base @var{value}
2009 Use @var{value} as the base address of your program or dll. This is
2010 the lowest memory location that will be used when your program or dll
2011 is loaded. To reduce the need to relocate and improve performance of
2012 your dlls, each should have a unique base address and not overlap any
2013 other dlls. The default is 0x400000 for executables, and 0x10000000
2015 [This option is specific to PE targets.]
2017 @item --section-alignment @var{num}
2018 Sets the section alignment field in the PE header. Sections in memory
2019 will always begin at addresses which are a multiple of this number.
2021 [This option is specific to PE targets.]
2023 @item --stack @var{reserve}
2024 @itemx --stack @var{reserve},@var{commit}
2025 Specify the number of bytes of memory to reserve (and optionally commit)
2026 to be used as stack for this program.
2027 [This option is specific to PE targets.]
2029 @item --subsystem @var{which}
2030 @itemx --subsystem @var{which}:@var{major}
2031 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2032 Specifies the subsystem under which your program will execute. The
2033 legal values for @var{which} are @code{native}, @code{windows},
2034 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
2035 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
2036 the subsystem version also. Numeric values are also accepted for
2038 [This option is specific to PE targets.]
2040 @item --extract-symbol
2041 Keep the file's section flags and symbols but remove all section data.
2042 Specifically, the option:
2045 @item removes the contents of all sections;
2046 @item sets the size of every section to zero; and
2047 @item sets the file's start address to zero.
2050 This option is used to build a @file{.sym} file for a VxWorks kernel.
2051 It can also be a useful way of reducing the size of a @option{--just-symbols}
2054 @item --compress-debug-sections
2055 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2056 ELF ABI. Note - if compression would actually make a section
2057 @emph{larger}, then it is not compressed.
2059 @item --compress-debug-sections=none
2060 @itemx --compress-debug-sections=zlib
2061 @itemx --compress-debug-sections=zlib-gnu
2062 @itemx --compress-debug-sections=zlib-gabi
2063 For ELF files, these options control how DWARF debug sections are
2064 compressed. @option{--compress-debug-sections=none} is equivalent
2065 to @option{--decompress-debug-sections}.
2066 @option{--compress-debug-sections=zlib} and
2067 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2068 @option{--compress-debug-sections}.
2069 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
2070 sections using zlib. The debug sections are renamed to begin with
2071 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
2072 actually make a section @emph{larger}, then it is not compressed nor
2075 @item --decompress-debug-sections
2076 Decompress DWARF debug sections using zlib. The original section
2077 names of the compressed sections are restored.
2079 @item --elf-stt-common=yes
2080 @itemx --elf-stt-common=no
2081 For ELF files, these options control whether common symbols should be
2082 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2083 @option{--elf-stt-common=yes} converts common symbol type to
2084 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2085 type to @code{STT_OBJECT}.
2088 @itemx --no-merge-notes
2089 For ELF files, attempt (or do not attempt) to reduce the size of any
2090 SHT_NOTE type sections by removing duplicate notes.
2094 Show the version number of @command{objcopy}.
2096 @item --verilog-data-width=@var{bytes}
2097 For Verilog output, this options controls the number of bytes
2098 converted for each output data element. The input target controls the
2099 endianness of the conversion.
2103 Verbose output: list all object files modified. In the case of
2104 archives, @samp{objcopy -V} lists all members of the archive.
2107 Show a summary of the options to @command{objcopy}.
2110 Display a list showing all architectures and object formats available.
2116 @c man begin SEEALSO objcopy
2117 ld(1), objdump(1), and the Info entries for @file{binutils}.
2124 @cindex object file information
2127 @c man title objdump display information from object files
2130 @c man begin SYNOPSIS objdump
2131 objdump [@option{-a}|@option{--archive-headers}]
2132 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2133 [@option{-C}|@option{--demangle}[=@var{style}] ]
2134 [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2135 [@option{-D}|@option{--disassemble-all}]
2136 [@option{-z}|@option{--disassemble-zeroes}]
2137 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2138 [@option{-f}|@option{--file-headers}]
2139 [@option{-F}|@option{--file-offsets}]
2140 [@option{--file-start-context}]
2141 [@option{-g}|@option{--debugging}]
2142 [@option{-e}|@option{--debugging-tags}]
2143 [@option{-h}|@option{--section-headers}|@option{--headers}]
2144 [@option{-i}|@option{--info}]
2145 [@option{-j} @var{section}|@option{--section=}@var{section}]
2146 [@option{-l}|@option{--line-numbers}]
2147 [@option{-S}|@option{--source}]
2148 [@option{--source-comment}[=@var{text}]]
2149 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2150 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2151 [@option{-p}|@option{--private-headers}]
2152 [@option{-P} @var{options}|@option{--private=}@var{options}]
2153 [@option{-r}|@option{--reloc}]
2154 [@option{-R}|@option{--dynamic-reloc}]
2155 [@option{-s}|@option{--full-contents}]
2156 [@option{-W[lLiaprmfFsoORtUuTgAckK]}|
2157 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
2158 [@option{--ctf=}@var{section}]
2159 [@option{-G}|@option{--stabs}]
2160 [@option{-t}|@option{--syms}]
2161 [@option{-T}|@option{--dynamic-syms}]
2162 [@option{-x}|@option{--all-headers}]
2163 [@option{-w}|@option{--wide}]
2164 [@option{--start-address=}@var{address}]
2165 [@option{--stop-address=}@var{address}]
2166 [@option{--no-addresses}]
2167 [@option{--prefix-addresses}]
2168 [@option{--[no-]show-raw-insn}]
2169 [@option{--adjust-vma=}@var{offset}]
2170 [@option{--dwarf-depth=@var{n}}]
2171 [@option{--dwarf-start=@var{n}}]
2172 [@option{--ctf-parent=}@var{section}]
2173 [@option{--no-recurse-limit}|@option{--recurse-limit}]
2174 [@option{--special-syms}]
2175 [@option{--prefix=}@var{prefix}]
2176 [@option{--prefix-strip=}@var{level}]
2177 [@option{--insn-width=}@var{width}]
2178 [@option{--visualize-jumps[=color|=extended-color|=off]}
2179 [@option{-V}|@option{--version}]
2180 [@option{-H}|@option{--help}]
2181 @var{objfile}@dots{}
2185 @c man begin DESCRIPTION objdump
2187 @command{objdump} displays information about one or more object files.
2188 The options control what particular information to display. This
2189 information is mostly useful to programmers who are working on the
2190 compilation tools, as opposed to programmers who just want their
2191 program to compile and work.
2193 @var{objfile}@dots{} are the object files to be examined. When you
2194 specify archives, @command{objdump} shows information on each of the member
2199 @c man begin OPTIONS objdump
2201 The long and short forms of options, shown here as alternatives, are
2202 equivalent. At least one option from the list
2203 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2207 @itemx --archive-header
2208 @cindex archive headers
2209 If any of the @var{objfile} files are archives, display the archive
2210 header information (in a format similar to @samp{ls -l}). Besides the
2211 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2212 the object file format of each archive member.
2214 @item --adjust-vma=@var{offset}
2215 @cindex section addresses in objdump
2216 @cindex VMA in objdump
2217 When dumping information, first add @var{offset} to all the section
2218 addresses. This is useful if the section addresses do not correspond to
2219 the symbol table, which can happen when putting sections at particular
2220 addresses when using a format which can not represent section addresses,
2223 @item -b @var{bfdname}
2224 @itemx --target=@var{bfdname}
2225 @cindex object code format
2226 Specify that the object-code format for the object files is
2227 @var{bfdname}. This option may not be necessary; @var{objdump} can
2228 automatically recognize many formats.
2232 objdump -b oasys -m vax -h fu.o
2235 displays summary information from the section headers (@option{-h}) of
2236 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2237 file in the format produced by Oasys compilers. You can list the
2238 formats available with the @option{-i} option.
2239 @xref{Target Selection}, for more information.
2242 @itemx --demangle[=@var{style}]
2243 @cindex demangling in objdump
2244 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2245 Besides removing any initial underscore prepended by the system, this
2246 makes C++ function names readable. Different compilers have different
2247 mangling styles. The optional demangling style argument can be used to
2248 choose an appropriate demangling style for your compiler. @xref{c++filt},
2249 for more information on demangling.
2251 @item --recurse-limit
2252 @itemx --no-recurse-limit
2253 @itemx --recursion-limit
2254 @itemx --no-recursion-limit
2255 Enables or disables a limit on the amount of recursion performed
2256 whilst demangling strings. Since the name mangling formats allow for
2257 an inifinite level of recursion it is possible to create strings whose
2258 decoding will exhaust the amount of stack space available on the host
2259 machine, triggering a memory fault. The limit tries to prevent this
2260 from happening by restricting recursion to 2048 levels of nesting.
2262 The default is for this limit to be enabled, but disabling it may be
2263 necessary in order to demangle truly complicated names. Note however
2264 that if the recursion limit is disabled then stack exhaustion is
2265 possible and any bug reports about such an event will be rejected.
2269 Display debugging information. This attempts to parse STABS
2270 debugging format information stored in the file and print it out using
2271 a C like syntax. If no STABS debugging was found this option
2272 falls back on the @option{-W} option to print any DWARF information in
2276 @itemx --debugging-tags
2277 Like @option{-g}, but the information is generated in a format compatible
2281 @itemx --disassemble
2282 @itemx --disassemble=@var{symbol}
2283 @cindex disassembling object code
2284 @cindex machine instructions
2285 Display the assembler mnemonics for the machine instructions from the
2286 input file. This option only disassembles those sections which are
2287 expected to contain instructions. If the optional @var{symbol}
2288 argument is given, then display the assembler mnemonics starting at
2289 @var{symbol}. If @var{symbol} is a function name then disassembly
2290 will stop at the end of the function, otherwise it will stop when the
2291 next symbol is encountered. If there are no matches for @var{symbol}
2292 then nothing will be displayed.
2294 Note if the @option{--dwarf=follow-links} option has also been enabled
2295 then any symbol tables in linked debug info files will be read in and
2296 used when disassembling.
2299 @itemx --disassemble-all
2300 Like @option{-d}, but disassemble the contents of all sections, not just
2301 those expected to contain instructions.
2303 This option also has a subtle effect on the disassembly of
2304 instructions in code sections. When option @option{-d} is in effect
2305 objdump will assume that any symbols present in a code section occur
2306 on the boundary between instructions and it will refuse to disassemble
2307 across such a boundary. When option @option{-D} is in effect however
2308 this assumption is supressed. This means that it is possible for the
2309 output of @option{-d} and @option{-D} to differ if, for example, data
2310 is stored in code sections.
2312 If the target is an ARM architecture this switch also has the effect
2313 of forcing the disassembler to decode pieces of data found in code
2314 sections as if they were instructions.
2316 Note if the @option{--dwarf=follow-links} option has also been enabled
2317 then any symbol tables in linked debug info files will be read in and
2318 used when disassembling.
2320 @item --no-addresses
2321 When disassembling, don't print addresses on each line or for symbols
2322 and relocation offsets. In combination with @option{--no-show-raw-insn}
2323 this may be useful for comparing compiler output.
2325 @item --prefix-addresses
2326 When disassembling, print the complete address on each line. This is
2327 the older disassembly format.
2331 @itemx --endian=@{big|little@}
2333 @cindex disassembly endianness
2334 Specify the endianness of the object files. This only affects
2335 disassembly. This can be useful when disassembling a file format which
2336 does not describe endianness information, such as S-records.
2339 @itemx --file-headers
2340 @cindex object file header
2341 Display summary information from the overall header of
2342 each of the @var{objfile} files.
2345 @itemx --file-offsets
2346 @cindex object file offsets
2347 When disassembling sections, whenever a symbol is displayed, also
2348 display the file offset of the region of data that is about to be
2349 dumped. If zeroes are being skipped, then when disassembly resumes,
2350 tell the user how many zeroes were skipped and the file offset of the
2351 location from where the disassembly resumes. When dumping sections,
2352 display the file offset of the location from where the dump starts.
2354 @item --file-start-context
2355 @cindex source code context
2356 Specify that when displaying interlisted source code/disassembly
2357 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2358 context to the start of the file.
2361 @itemx --section-headers
2363 @cindex section headers
2364 Display summary information from the section headers of the
2367 File segments may be relocated to nonstandard addresses, for example by
2368 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2369 @command{ld}. However, some object file formats, such as a.out, do not
2370 store the starting address of the file segments. In those situations,
2371 although @command{ld} relocates the sections correctly, using @samp{objdump
2372 -h} to list the file section headers cannot show the correct addresses.
2373 Instead, it shows the usual addresses, which are implicit for the
2376 Note, in some cases it is possible for a section to have both the
2377 READONLY and the NOREAD attributes set. In such cases the NOREAD
2378 attribute takes precedence, but @command{objdump} will report both
2379 since the exact setting of the flag bits might be important.
2383 Print a summary of the options to @command{objdump} and exit.
2387 @cindex architectures available
2388 @cindex object formats available
2389 Display a list showing all architectures and object formats available
2390 for specification with @option{-b} or @option{-m}.
2393 @itemx --section=@var{name}
2394 @cindex section information
2395 Display information only for section @var{name}.
2398 @itemx --line-numbers
2399 @cindex source filenames for object files
2400 Label the display (using debugging information) with the filename and
2401 source line numbers corresponding to the object code or relocs shown.
2402 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2404 @item -m @var{machine}
2405 @itemx --architecture=@var{machine}
2406 @cindex architecture
2407 @cindex disassembly architecture
2408 Specify the architecture to use when disassembling object files. This
2409 can be useful when disassembling object files which do not describe
2410 architecture information, such as S-records. You can list the available
2411 architectures with the @option{-i} option.
2413 If the target is an ARM architecture then this switch has an
2414 additional effect. It restricts the disassembly to only those
2415 instructions supported by the architecture specified by @var{machine}.
2416 If it is necessary to use this switch because the input file does not
2417 contain any architecture information, but it is also desired to
2418 disassemble all the instructions use @option{-marm}.
2420 @item -M @var{options}
2421 @itemx --disassembler-options=@var{options}
2422 Pass target specific information to the disassembler. Only supported on
2423 some targets. If it is necessary to specify more than one
2424 disassembler option then multiple @option{-M} options can be used or
2425 can be placed together into a comma separated list.
2427 For ARC, @option{dsp} controls the printing of DSP instructions,
2428 @option{spfp} selects the printing of FPX single precision FP
2429 instructions, @option{dpfp} selects the printing of FPX double
2430 precision FP instructions, @option{quarkse_em} selects the printing of
2431 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2432 of double precision assist instructions, @option{fpus} selects the
2433 printing of FPU single precision FP instructions, while @option{fpud}
2434 selects the printing of FPU double precision FP instructions.
2435 Additionally, one can choose to have all the immediates printed in
2436 hexadecimal using @option{hex}. By default, the short immediates are
2437 printed using the decimal representation, while the long immediate
2438 values are printed as hexadecimal.
2440 @option{cpu=...} allows to enforce a particular ISA when disassembling
2441 instructions, overriding the @option{-m} value or whatever is in the ELF file.
2442 This might be useful to select ARC EM or HS ISA, because architecture is same
2443 for those and disassembler relies on private ELF header data to decide if code
2444 is for EM or HS. This option might be specified multiple times - only the
2445 latest value will be used. Valid values are same as for the assembler
2446 @option{-mcpu=...} option.
2448 If the target is an ARM architecture then this switch can be used to
2449 select which register name set is used during disassembler. Specifying
2450 @option{-M reg-names-std} (the default) will select the register names as
2451 used in ARM's instruction set documentation, but with register 13 called
2452 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2453 @option{-M reg-names-apcs} will select the name set used by the ARM
2454 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2455 just use @samp{r} followed by the register number.
2457 There are also two variants on the APCS register naming scheme enabled
2458 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2459 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2460 with the normal register names or the special register names).
2462 This option can also be used for ARM architectures to force the
2463 disassembler to interpret all instructions as Thumb instructions by
2464 using the switch @option{--disassembler-options=force-thumb}. This can be
2465 useful when attempting to disassemble thumb code produced by other
2468 For AArch64 targets this switch can be used to set whether instructions are
2469 disassembled as the most general instruction using the @option{-M no-aliases}
2470 option or whether instruction notes should be generated as comments in the
2471 disasssembly using @option{-M notes}.
2473 For the x86, some of the options duplicate functions of the @option{-m}
2474 switch, but allow finer grained control.
2479 Select disassembly for the given architecture.
2483 Select between intel syntax mode and AT&T syntax mode.
2487 Select between AMD64 ISA and Intel64 ISA.
2489 @item intel-mnemonic
2491 Select between intel mnemonic mode and AT&T mnemonic mode.
2492 Note: @code{intel-mnemonic} implies @code{intel} and
2493 @code{att-mnemonic} implies @code{att}.
2500 Specify the default address size and operand size. These five options
2501 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2502 appear later in the option string.
2505 When in AT&T mode and also for a limited set of instructions when in Intel
2506 mode, instructs the disassembler to print a mnemonic suffix even when the
2507 suffix could be inferred by the operands or, for certain instructions, the
2508 execution mode's defaults.
2511 For PowerPC, the @option{-M} argument @option{raw} selects
2512 disasssembly of hardware insns rather than aliases. For example, you
2513 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2514 rather than @code{li}. All of the @option{-m} arguments for
2515 @command{gas} that select a CPU are supported. These are:
2516 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2517 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2518 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2519 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2520 @option{booke32}, @option{cell}, @option{com}, @option{e200z4},
2521 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2522 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2523 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2524 @option{power8}, @option{power9}, @option{power10}, @option{ppc},
2525 @option{ppc32}, @option{ppc64}, @option{ppc64bridge}, @option{ppcps},
2526 @option{pwr}, @option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2527 @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9}, @option{pwr10},
2528 @option{pwrx}, @option{titan}, and @option{vle}.
2529 @option{32} and @option{64} modify the default or a prior CPU
2530 selection, disabling and enabling 64-bit insns respectively. In
2531 addition, @option{altivec}, @option{any}, @option{htm}, @option{vsx},
2532 and @option{spe} add capabilities to a previous @emph{or later} CPU
2533 selection. @option{any} will disassemble any opcode known to
2534 binutils, but in cases where an opcode has two different meanings or
2535 different arguments, you may not see the disassembly you expect.
2536 If you disassemble without giving a CPU selection, a default will be
2537 chosen from information gleaned by BFD from the object files headers,
2538 but the result again may not be as you expect.
2540 For MIPS, this option controls the printing of instruction mnemonic
2541 names and register names in disassembled instructions. Multiple
2542 selections from the following may be specified as a comma separated
2543 string, and invalid options are ignored:
2547 Print the 'raw' instruction mnemonic instead of some pseudo
2548 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2549 'sll' instead of 'nop', etc.
2552 Disassemble MSA instructions.
2555 Disassemble the virtualization ASE instructions.
2558 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2560 @item gpr-names=@var{ABI}
2561 Print GPR (general-purpose register) names as appropriate
2562 for the specified ABI. By default, GPR names are selected according to
2563 the ABI of the binary being disassembled.
2565 @item fpr-names=@var{ABI}
2566 Print FPR (floating-point register) names as
2567 appropriate for the specified ABI. By default, FPR numbers are printed
2570 @item cp0-names=@var{ARCH}
2571 Print CP0 (system control coprocessor; coprocessor 0) register names
2572 as appropriate for the CPU or architecture specified by
2573 @var{ARCH}. By default, CP0 register names are selected according to
2574 the architecture and CPU of the binary being disassembled.
2576 @item hwr-names=@var{ARCH}
2577 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2578 as appropriate for the CPU or architecture specified by
2579 @var{ARCH}. By default, HWR names are selected according to
2580 the architecture and CPU of the binary being disassembled.
2582 @item reg-names=@var{ABI}
2583 Print GPR and FPR names as appropriate for the selected ABI.
2585 @item reg-names=@var{ARCH}
2586 Print CPU-specific register names (CP0 register and HWR names)
2587 as appropriate for the selected CPU or architecture.
2590 For any of the options listed above, @var{ABI} or
2591 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2592 rather than names, for the selected types of registers.
2593 You can list the available values of @var{ABI} and @var{ARCH} using
2594 the @option{--help} option.
2596 For VAX, you can specify function entry addresses with @option{-M
2597 entry:0xf00ba}. You can use this multiple times to properly
2598 disassemble VAX binary files that don't contain symbol tables (like
2599 ROM dumps). In these cases, the function entry mask would otherwise
2600 be decoded as VAX instructions, which would probably lead the rest
2601 of the function being wrongly disassembled.
2604 @itemx --private-headers
2605 Print information that is specific to the object file format. The exact
2606 information printed depends upon the object file format. For some
2607 object file formats, no additional information is printed.
2609 @item -P @var{options}
2610 @itemx --private=@var{options}
2611 Print information that is specific to the object file format. The
2612 argument @var{options} is a comma separated list that depends on the
2613 format (the lists of options is displayed with the help).
2615 For XCOFF, the available options are:
2631 Not all object formats support this option. In particular the ELF
2632 format does not use it.
2636 @cindex relocation entries, in object file
2637 Print the relocation entries of the file. If used with @option{-d} or
2638 @option{-D}, the relocations are printed interspersed with the
2642 @itemx --dynamic-reloc
2643 @cindex dynamic relocation entries, in object file
2644 Print the dynamic relocation entries of the file. This is only
2645 meaningful for dynamic objects, such as certain types of shared
2646 libraries. As for @option{-r}, if used with @option{-d} or
2647 @option{-D}, the relocations are printed interspersed with the
2651 @itemx --full-contents
2652 @cindex sections, full contents
2653 @cindex object file sections
2654 Display the full contents of any sections requested. By default all
2655 non-empty sections are displayed.
2659 @cindex source disassembly
2660 @cindex disassembly, with source
2661 Display source code intermixed with disassembly, if possible. Implies
2664 @item --source-comment[=@var{txt}]
2665 @cindex source disassembly
2666 @cindex disassembly, with source
2667 Like the @option{-S} option, but all source code lines are displayed
2668 with a prefix of @var{txt}. Typically @var{txt} will be a comment
2669 string which can be used to distinguish the assembler code from the
2670 source code. If @var{txt} is not provided then a default string of
2671 @var{``# ``} (hash followed by a space), will be used.
2673 @item --prefix=@var{prefix}
2674 @cindex Add prefix to absolute paths
2675 Specify @var{prefix} to add to the absolute paths when used with
2678 @item --prefix-strip=@var{level}
2679 @cindex Strip absolute paths
2680 Indicate how many initial directory names to strip off the hardwired
2681 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2683 @item --show-raw-insn
2684 When disassembling instructions, print the instruction in hex as well as
2685 in symbolic form. This is the default except when
2686 @option{--prefix-addresses} is used.
2688 @item --no-show-raw-insn
2689 When disassembling instructions, do not print the instruction bytes.
2690 This is the default when @option{--prefix-addresses} is used.
2692 @item --insn-width=@var{width}
2693 @cindex Instruction width
2694 Display @var{width} bytes on a single line when disassembling
2697 @item --visualize-jumps[=color|=extended-color|=off]
2698 Visualize jumps that stay inside a function by drawing ASCII art between
2699 the start and target addresses. The optional @option{=color} argument
2700 adds color to the output using simple terminal colors. Alternatively
2701 the @option{=extended-color} argument will add color using 8bit
2702 colors, but these might not work on all terminals.
2704 If it is necessary to disable the @option{visualize-jumps} option
2705 after it has previously been enabled then use
2706 @option{visualize-jumps=off}.
2708 @item -W[lLiaprmfFsoORtUuTgAckK]
2709 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2710 @include debug.options.texi
2713 Enable additional checks for consistency of Dwarf information.
2715 @include ctf.options.texi
2721 @cindex debug symbols
2722 @cindex ELF object file format
2723 Display the full contents of any sections requested. Display the
2724 contents of the .stab and .stab.index and .stab.excl sections from an
2725 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2726 @code{.stab} debugging symbol-table entries are carried in an ELF
2727 section. In most other file formats, debugging symbol-table entries are
2728 interleaved with linkage symbols, and are visible in the @option{--syms}
2731 @item --start-address=@var{address}
2732 @cindex start-address
2733 Start displaying data at the specified address. This affects the output
2734 of the @option{-d}, @option{-r} and @option{-s} options.
2736 @item --stop-address=@var{address}
2737 @cindex stop-address
2738 Stop displaying data at the specified address. This affects the output
2739 of the @option{-d}, @option{-r} and @option{-s} options.
2743 @cindex symbol table entries, printing
2744 Print the symbol table entries of the file.
2745 This is similar to the information provided by the @samp{nm} program,
2746 although the display format is different. The format of the output
2747 depends upon the format of the file being dumped, but there are two main
2748 types. One looks like this:
2751 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2752 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2755 where the number inside the square brackets is the number of the entry
2756 in the symbol table, the @var{sec} number is the section number, the
2757 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2758 symbol's type, the @var{scl} number is the symbol's storage class and
2759 the @var{nx} value is the number of auxilary entries associated with
2760 the symbol. The last two fields are the symbol's value and its name.
2762 The other common output format, usually seen with ELF based files,
2766 00000000 l d .bss 00000000 .bss
2767 00000000 g .text 00000000 fred
2770 Here the first number is the symbol's value (sometimes refered to as
2771 its address). The next field is actually a set of characters and
2772 spaces indicating the flag bits that are set on the symbol. These
2773 characters are described below. Next is the section with which the
2774 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2775 not connected with any section), or @emph{*UND*} if the section is
2776 referenced in the file being dumped, but not defined there.
2778 After the section name comes another field, a number, which for common
2779 symbols is the alignment and for other symbol is the size. Finally
2780 the symbol's name is displayed.
2782 The flag characters are divided into 7 groups as follows:
2788 The symbol is a local (l), global (g), unique global (u), neither
2789 global nor local (a space) or both global and local (!). A
2790 symbol can be neither local or global for a variety of reasons, e.g.,
2791 because it is used for debugging, but it is probably an indication of
2792 a bug if it is ever both local and global. Unique global symbols are
2793 a GNU extension to the standard set of ELF symbol bindings. For such
2794 a symbol the dynamic linker will make sure that in the entire process
2795 there is just one symbol with this name and type in use.
2798 The symbol is weak (w) or strong (a space).
2801 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2804 The symbol is a warning (W) or a normal symbol (a space). A warning
2805 symbol's name is a message to be displayed if the symbol following the
2806 warning symbol is ever referenced.
2810 The symbol is an indirect reference to another symbol (I), a function
2811 to be evaluated during reloc processing (i) or a normal symbol (a
2816 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2817 normal symbol (a space).
2822 The symbol is the name of a function (F) or a file (f) or an object
2823 (O) or just a normal symbol (a space).
2827 @itemx --dynamic-syms
2828 @cindex dynamic symbol table entries, printing
2829 Print the dynamic symbol table entries of the file. This is only
2830 meaningful for dynamic objects, such as certain types of shared
2831 libraries. This is similar to the information provided by the @samp{nm}
2832 program when given the @option{-D} (@option{--dynamic}) option.
2834 The output format is similar to that produced by the @option{--syms}
2835 option, except that an extra field is inserted before the symbol's
2836 name, giving the version information associated with the symbol.
2837 If the version is the default version to be used when resolving
2838 unversioned references to the symbol then it's displayed as is,
2839 otherwise it's put into parentheses.
2841 @item --special-syms
2842 When displaying symbols include those which the target considers to be
2843 special in some way and which would not normally be of interest to the
2848 Print the version number of @command{objdump} and exit.
2851 @itemx --all-headers
2852 @cindex all header information, object file
2853 @cindex header information, all
2854 Display all available header information, including the symbol table and
2855 relocation entries. Using @option{-x} is equivalent to specifying all of
2856 @option{-a -f -h -p -r -t}.
2860 @cindex wide output, printing
2861 Format some lines for output devices that have more than 80 columns.
2862 Also do not truncate symbol names when they are displayed.
2865 @itemx --disassemble-zeroes
2866 Normally the disassembly output will skip blocks of zeroes. This
2867 option directs the disassembler to disassemble those blocks, just like
2874 @c man begin SEEALSO objdump
2875 nm(1), readelf(1), and the Info entries for @file{binutils}.
2883 @cindex archive contents
2884 @cindex symbol index
2886 @c man title ranlib generate an index to an archive
2889 @c man begin SYNOPSIS ranlib
2890 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2894 @c man begin DESCRIPTION ranlib
2896 @command{ranlib} generates an index to the contents of an archive and
2897 stores it in the archive. The index lists each symbol defined by a
2898 member of an archive that is a relocatable object file.
2900 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2902 An archive with such an index speeds up linking to the library and
2903 allows routines in the library to call each other without regard to
2904 their placement in the archive.
2906 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2907 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2912 @c man begin OPTIONS ranlib
2918 Show usage information for @command{ranlib}.
2923 Show the version number of @command{ranlib}.
2926 @cindex deterministic archives
2927 @kindex --enable-deterministic-archives
2928 Operate in @emph{deterministic} mode. The symbol map archive member's
2929 header will show zero for the UID, GID, and timestamp. When this
2930 option is used, multiple runs will produce identical output files.
2932 If @file{binutils} was configured with
2933 @option{--enable-deterministic-archives}, then this mode is on by
2934 default. It can be disabled with the @samp{-U} option, described
2938 Update the timestamp of the symbol map of an archive.
2941 @cindex deterministic archives
2942 @kindex --enable-deterministic-archives
2943 Do @emph{not} operate in @emph{deterministic} mode. This is the
2944 inverse of the @samp{-D} option, above: the archive index will get
2945 actual UID, GID, timestamp, and file mode values.
2947 If @file{binutils} was configured @emph{without}
2948 @option{--enable-deterministic-archives}, then this mode is on by
2956 @c man begin SEEALSO ranlib
2957 ar(1), nm(1), and the Info entries for @file{binutils}.
2965 @cindex section sizes
2967 @c man title size list section sizes and total size of binary files
2970 @c man begin SYNOPSIS size
2971 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
2973 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2975 [@option{-t}|@option{--totals}]
2976 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2977 [@var{objfile}@dots{}]
2981 @c man begin DESCRIPTION size
2983 The @sc{gnu} @command{size} utility lists the section sizes and the total
2984 size for each of the binary files @var{objfile} on its argument list.
2985 By default, one line of output is generated for each file or each
2986 module if the file is an archive.
2988 @var{objfile}@dots{} are the files to be examined. If none are
2989 specified, the file @code{a.out} will be used instead.
2993 @c man begin OPTIONS size
2995 The command-line options have the following meanings:
3001 @itemx --format=@var{compatibility}
3002 @cindex @command{size} display format
3003 Using one of these options, you can choose whether the output from @sc{gnu}
3004 @command{size} resembles output from System V @command{size} (using @option{-A},
3005 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
3006 @option{--format=berkeley}). The default is the one-line format similar to
3007 Berkeley's. Alternatively, you can choose the GNU format output
3008 (using @option{-G}, or @option{--format=gnu}), this is similar to
3009 Berkeley's output format, but sizes are counted differently.
3010 @c Bonus for doc-source readers: you can also say --format=strange (or
3011 @c anything else that starts with 's') for sysv, and --format=boring (or
3012 @c anything else that starts with 'b') for Berkeley.
3014 Here is an example of the Berkeley (default) format of output from
3017 $ size --format=Berkeley ranlib size
3018 text data bss dec hex filename
3019 294880 81920 11592 388392 5ed28 ranlib
3020 294880 81920 11888 388688 5ee50 size
3023 The Berkeley style output counts read only data in the @code{text}
3024 column, not in the @code{data} column, the @code{dec} and @code{hex}
3025 columns both display the sum of the @code{text}, @code{data}, and
3026 @code{bss} columns in decimal and hexadecimal respectively.
3028 The GNU format counts read only data in the @code{data} column, not
3029 the @code{text} column, and only displays the sum of the @code{text},
3030 @code{data}, and @code{bss} columns once, in the @code{total} column.
3031 The @option{--radix} option can be used to change the number base for
3032 all columns. Here is the same data displayed with GNU conventions:
3035 $ size --format=GNU ranlib size
3036 text data bss total filename
3037 279880 96920 11592 388392 ranlib
3038 279880 96920 11888 388688 size
3042 This is the same data, but displayed closer to System V conventions:
3045 $ size --format=SysV ranlib size
3063 Show a summary of acceptable arguments and options.
3068 @itemx --radix=@var{number}
3069 @cindex @command{size} number format
3070 @cindex radix for section sizes
3071 Using one of these options, you can control whether the size of each
3072 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3073 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3074 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
3075 values (8, 10, 16) are supported. The total size is always given in two
3076 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3077 octal and hexadecimal if you're using @option{-o}.
3080 Print total size of common symbols in each file. When using Berkeley
3081 or GNU format these are included in the bss size.
3085 Show totals of all objects listed (Berkeley or GNU format mode only).
3087 @item --target=@var{bfdname}
3088 @cindex object code format
3089 Specify that the object-code format for @var{objfile} is
3090 @var{bfdname}. This option may not be necessary; @command{size} can
3091 automatically recognize many formats.
3092 @xref{Target Selection}, for more information.
3096 Display the version number of @command{size}.
3102 @c man begin SEEALSO size
3103 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3110 @cindex listings strings
3111 @cindex printing strings
3112 @cindex strings, printing
3114 @c man title strings print the sequences of printable characters in files
3117 @c man begin SYNOPSIS strings
3118 strings [@option{-afovV}] [@option{-}@var{min-len}]
3119 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3120 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3121 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3122 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3123 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3124 [@option{-w}] [@option{--include-all-whitespace}]
3125 [@option{-s}] [@option{--output-separator}@var{sep_string}]
3126 [@option{--help}] [@option{--version}] @var{file}@dots{}
3130 @c man begin DESCRIPTION strings
3132 For each @var{file} given, @sc{gnu} @command{strings} prints the
3133 printable character sequences that are at least 4 characters long (or
3134 the number given with the options below) and are followed by an
3135 unprintable character.
3137 Depending upon how the strings program was configured it will default
3138 to either displaying all the printable sequences that it can find in
3139 each file, or only those sequences that are in loadable, initialized
3140 data sections. If the file type is unrecognizable, or if strings is
3141 reading from stdin then it will always display all of the printable
3142 sequences that it can find.
3144 For backwards compatibility any file that occurs after a command-line
3145 option of just @option{-} will also be scanned in full, regardless of
3146 the presence of any @option{-d} option.
3148 @command{strings} is mainly useful for determining the contents of
3153 @c man begin OPTIONS strings
3159 Scan the whole file, regardless of what sections it contains or
3160 whether those sections are loaded or initialized. Normally this is
3161 the default behaviour, but strings can be configured so that the
3162 @option{-d} is the default instead.
3164 The @option{-} option is position dependent and forces strings to
3165 perform full scans of any file that is mentioned after the @option{-}
3166 on the command line, even if the @option{-d} option has been
3171 Only print strings from initialized, loaded data sections in the
3172 file. This may reduce the amount of garbage in the output, but it
3173 also exposes the strings program to any security flaws that may be
3174 present in the BFD library used to scan and load sections. Strings
3175 can be configured so that this option is the default behaviour. In
3176 such cases the @option{-a} option can be used to avoid using the BFD
3177 library and instead just print all of the strings found in the file.
3180 @itemx --print-file-name
3181 Print the name of the file before each string.
3184 Print a summary of the program usage on the standard output and exit.
3186 @item -@var{min-len}
3187 @itemx -n @var{min-len}
3188 @itemx --bytes=@var{min-len}
3189 Print sequences of characters that are at least @var{min-len} characters
3190 long, instead of the default 4.
3193 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3194 act like @samp{-t d} instead. Since we can not be compatible with both
3195 ways, we simply chose one.
3197 @item -t @var{radix}
3198 @itemx --radix=@var{radix}
3199 Print the offset within the file before each string. The single
3200 character argument specifies the radix of the offset---@samp{o} for
3201 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3203 @item -e @var{encoding}
3204 @itemx --encoding=@var{encoding}
3205 Select the character encoding of the strings that are to be found.
3206 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3207 characters (ASCII, ISO 8859, etc., default), @samp{S} =
3208 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3209 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3210 littleendian. Useful for finding wide character strings. (@samp{l}
3211 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3213 @item -T @var{bfdname}
3214 @itemx --target=@var{bfdname}
3215 @cindex object code format
3216 Specify an object code format other than your system's default format.
3217 @xref{Target Selection}, for more information.
3222 Print the program version number on the standard output and exit.
3225 @itemx --include-all-whitespace
3226 By default tab and space characters are included in the strings that
3227 are displayed, but other whitespace characters, such a newlines and
3228 carriage returns, are not. The @option{-w} option changes this so
3229 that all whitespace characters are considered to be part of a string.
3232 @itemx --output-separator
3233 By default, output strings are delimited by a new-line. This option
3234 allows you to supply any string to be used as the output record
3235 separator. Useful with --include-all-whitespace where strings
3236 may contain new-lines internally.
3242 @c man begin SEEALSO strings
3243 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3244 and the Info entries for @file{binutils}.
3252 @cindex removing symbols
3253 @cindex discarding symbols
3254 @cindex symbols, discarding
3256 @c man title strip discard symbols and other data from object files
3259 @c man begin SYNOPSIS strip
3260 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3261 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3262 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3263 [@option{-s}|@option{--strip-all}]
3264 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3265 [@option{--strip-dwo}]
3266 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3267 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3268 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3269 [@option{-w}|@option{--wildcard}]
3270 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3271 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3272 [@option{--keep-section=}@var{sectionpattern}]
3273 [@option{--remove-relocations=}@var{sectionpattern}]
3274 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3275 [@option{-D}|@option{--enable-deterministic-archives}]
3276 [@option{-U}|@option{--disable-deterministic-archives}]
3277 [@option{--keep-file-symbols}]
3278 [@option{--only-keep-debug}]
3279 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3280 [@option{--help}] [@option{--info}]
3281 @var{objfile}@dots{}
3285 @c man begin DESCRIPTION strip
3287 @sc{gnu} @command{strip} discards all symbols from object files
3288 @var{objfile}. The list of object files may include archives.
3289 At least one object file must be given.
3291 @command{strip} modifies the files named in its argument,
3292 rather than writing modified copies under different names.
3296 @c man begin OPTIONS strip
3299 @item -F @var{bfdname}
3300 @itemx --target=@var{bfdname}
3301 Treat the original @var{objfile} as a file with the object
3302 code format @var{bfdname}, and rewrite it in the same format.
3303 @xref{Target Selection}, for more information.
3306 Show a summary of the options to @command{strip} and exit.
3309 Display a list showing all architectures and object formats available.
3311 @item -I @var{bfdname}
3312 @itemx --input-target=@var{bfdname}
3313 Treat the original @var{objfile} as a file with the object
3314 code format @var{bfdname}.
3315 @xref{Target Selection}, for more information.
3317 @item -O @var{bfdname}
3318 @itemx --output-target=@var{bfdname}
3319 Replace @var{objfile} with a file in the output format @var{bfdname}.
3320 @xref{Target Selection}, for more information.
3322 @item -R @var{sectionname}
3323 @itemx --remove-section=@var{sectionname}
3324 Remove any section named @var{sectionname} from the output file, in
3325 addition to whatever sections would otherwise be removed. This
3326 option may be given more than once. Note that using this option
3327 inappropriately may make the output file unusable. The wildcard
3328 character @samp{*} may be given at the end of @var{sectionname}. If
3329 so, then any section starting with @var{sectionname} will be removed.
3331 If the first character of @var{sectionpattern} is the exclamation
3332 point (!) then matching sections will not be removed even if an
3333 earlier use of @option{--remove-section} on the same command line
3334 would otherwise remove it. For example:
3337 --remove-section=.text.* --remove-section=!.text.foo
3340 will remove all sections matching the pattern '.text.*', but will not
3341 remove the section '.text.foo'.
3343 @item --keep-section=@var{sectionpattern}
3344 When removing sections from the output file, keep sections that match
3345 @var{sectionpattern}.
3347 @item --remove-relocations=@var{sectionpattern}
3348 Remove relocations from the output file for any section matching
3349 @var{sectionpattern}. This option may be given more than once. Note
3350 that using this option inappropriately may make the output file
3351 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3355 --remove-relocations=.text.*
3358 will remove the relocations for all sections matching the patter
3361 If the first character of @var{sectionpattern} is the exclamation
3362 point (!) then matching sections will not have their relocation
3363 removed even if an earlier use of @option{--remove-relocations} on the
3364 same command line would otherwise cause the relocations to be removed.
3368 --remove-relocations=.text.* --remove-relocations=!.text.foo
3371 will remove all relocations for sections matching the pattern
3372 '.text.*', but will not remove relocations for the section
3382 @itemx --strip-debug
3383 Remove debugging symbols only.
3386 Remove the contents of all DWARF .dwo sections, leaving the
3387 remaining debugging sections and all symbols intact.
3388 See the description of this option in the @command{objcopy} section
3389 for more information.
3391 @item --strip-unneeded
3392 Remove all symbols that are not needed for relocation processing.
3394 @item -K @var{symbolname}
3395 @itemx --keep-symbol=@var{symbolname}
3396 When stripping symbols, keep symbol @var{symbolname} even if it would
3397 normally be stripped. This option may be given more than once.
3400 @itemx --merge-notes
3401 @itemx --no-merge-notes
3402 For ELF files, attempt (or do not attempt) to reduce the size of any
3403 SHT_NOTE type sections by removing duplicate notes. The default is to
3404 attempt this reduction unless stripping debug or DWO information.
3406 @item -N @var{symbolname}
3407 @itemx --strip-symbol=@var{symbolname}
3408 Remove symbol @var{symbolname} from the source file. This option may be
3409 given more than once, and may be combined with strip options other than
3413 Put the stripped output in @var{file}, rather than replacing the
3414 existing file. When this argument is used, only one @var{objfile}
3415 argument may be specified.
3418 @itemx --preserve-dates
3419 Preserve the access and modification dates of the file.
3422 @itemx --enable-deterministic-archives
3423 @cindex deterministic archives
3424 @kindex --enable-deterministic-archives
3425 Operate in @emph{deterministic} mode. When copying archive members
3426 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3427 and use consistent file modes for all files.
3429 If @file{binutils} was configured with
3430 @option{--enable-deterministic-archives}, then this mode is on by default.
3431 It can be disabled with the @samp{-U} option, below.
3434 @itemx --disable-deterministic-archives
3435 @cindex deterministic archives
3436 @kindex --enable-deterministic-archives
3437 Do @emph{not} operate in @emph{deterministic} mode. This is the
3438 inverse of the @option{-D} option, above: when copying archive members
3439 and writing the archive index, use their actual UID, GID, timestamp,
3440 and file mode values.
3442 This is the default unless @file{binutils} was configured with
3443 @option{--enable-deterministic-archives}.
3447 Permit regular expressions in @var{symbolname}s used in other command
3448 line options. The question mark (?), asterisk (*), backslash (\) and
3449 square brackets ([]) operators can be used anywhere in the symbol
3450 name. If the first character of the symbol name is the exclamation
3451 point (!) then the sense of the switch is reversed for that symbol.
3458 would cause strip to only keep symbols that start with the letters
3459 ``fo'', but to discard the symbol ``foo''.
3462 @itemx --discard-all
3463 Remove non-global symbols.
3466 @itemx --discard-locals
3467 Remove compiler-generated local symbols.
3468 (These usually start with @samp{L} or @samp{.}.)
3470 @item --keep-file-symbols
3471 When stripping a file, perhaps with @option{--strip-debug} or
3472 @option{--strip-unneeded}, retain any symbols specifying source file names,
3473 which would otherwise get stripped.
3475 @item --only-keep-debug
3476 Strip a file, emptying the contents of any sections that would not be
3477 stripped by @option{--strip-debug} and leaving the debugging sections
3478 intact. In ELF files, this preserves all the note sections in the
3481 Note - the section headers of the stripped sections are preserved,
3482 including their sizes, but the contents of the section are discarded.
3483 The section headers are preserved so that other tools can match up the
3484 debuginfo file with the real executable, even if that executable has
3485 been relocated to a different address space.
3487 The intention is that this option will be used in conjunction with
3488 @option{--add-gnu-debuglink} to create a two part executable. One a
3489 stripped binary which will occupy less space in RAM and in a
3490 distribution and the second a debugging information file which is only
3491 needed if debugging abilities are required. The suggested procedure
3492 to create these files is as follows:
3495 @item Link the executable as normal. Assuming that it is called
3497 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3498 create a file containing the debugging info.
3499 @item Run @code{objcopy --strip-debug foo} to create a
3500 stripped executable.
3501 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3502 to add a link to the debugging info into the stripped executable.
3505 Note---the choice of @code{.dbg} as an extension for the debug info
3506 file is arbitrary. Also the @code{--only-keep-debug} step is
3507 optional. You could instead do this:
3510 @item Link the executable as normal.
3511 @item Copy @code{foo} to @code{foo.full}
3512 @item Run @code{strip --strip-debug foo}
3513 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3516 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3517 full executable. It does not have to be a file created by the
3518 @option{--only-keep-debug} switch.
3520 Note---this switch is only intended for use on fully linked files. It
3521 does not make sense to use it on object files where the debugging
3522 information may be incomplete. Besides the gnu_debuglink feature
3523 currently only supports the presence of one filename containing
3524 debugging information, not multiple filenames on a one-per-object-file
3529 Show the version number for @command{strip}.
3533 Verbose output: list all object files modified. In the case of
3534 archives, @samp{strip -v} lists all members of the archive.
3540 @c man begin SEEALSO strip
3541 the Info entries for @file{binutils}.
3545 @node c++filt, addr2line, strip, Top
3549 @cindex demangling C++ symbols
3551 @c man title cxxfilt demangle C++ and Java symbols
3554 @c man begin SYNOPSIS cxxfilt
3555 c++filt [@option{-_}|@option{--strip-underscore}]
3556 [@option{-n}|@option{--no-strip-underscore}]
3557 [@option{-p}|@option{--no-params}]
3558 [@option{-t}|@option{--types}]
3559 [@option{-i}|@option{--no-verbose}]
3560 [@option{-r}|@option{--no-recurse-limit}]
3561 [@option{-R}|@option{--recurse-limit}]
3562 [@option{-s} @var{format}|@option{--format=}@var{format}]
3563 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3567 @c man begin DESCRIPTION cxxfilt
3570 The C++ and Java languages provide function overloading, which means
3571 that you can write many functions with the same name, providing that
3572 each function takes parameters of different types. In order to be
3573 able to distinguish these similarly named functions C++ and Java
3574 encode them into a low-level assembler name which uniquely identifies
3575 each different version. This process is known as @dfn{mangling}. The
3577 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3578 MS-DOS this program is named @command{CXXFILT}.}
3579 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3580 names into user-level names so that they can be read.
3582 Every alphanumeric word (consisting of letters, digits, underscores,
3583 dollars, or periods) seen in the input is a potential mangled name.
3584 If the name decodes into a C++ name, the C++ name replaces the
3585 low-level name in the output, otherwise the original word is output.
3586 In this way you can pass an entire assembler source file, containing
3587 mangled names, through @command{c++filt} and see the same source file
3588 containing demangled names.
3590 You can also use @command{c++filt} to decipher individual symbols by
3591 passing them on the command line:
3594 c++filt @var{symbol}
3597 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3598 names from the standard input instead. All the results are printed on
3599 the standard output. The difference between reading names from the
3600 command line versus reading names from the standard input is that
3601 command-line arguments are expected to be just mangled names and no
3602 checking is performed to separate them from surrounding text. Thus
3609 will work and demangle the name to ``f()'' whereas:
3615 will not work. (Note the extra comma at the end of the mangled
3616 name which makes it invalid). This command however will work:
3619 echo _Z1fv, | c++filt -n
3622 and will display ``f(),'', i.e., the demangled name followed by a
3623 trailing comma. This behaviour is because when the names are read
3624 from the standard input it is expected that they might be part of an
3625 assembler source file where there might be extra, extraneous
3626 characters trailing after a mangled name. For example:
3629 .type _Z1fv, @@function
3634 @c man begin OPTIONS cxxfilt
3638 @itemx --strip-underscore
3639 On some systems, both the C and C++ compilers put an underscore in front
3640 of every name. For example, the C name @code{foo} gets the low-level
3641 name @code{_foo}. This option removes the initial underscore. Whether
3642 @command{c++filt} removes the underscore by default is target dependent.
3645 @itemx --no-strip-underscore
3646 Do not remove the initial underscore.
3650 When demangling the name of a function, do not display the types of
3651 the function's parameters.
3655 Attempt to demangle types as well as function names. This is disabled
3656 by default since mangled types are normally only used internally in
3657 the compiler, and they can be confused with non-mangled names. For example,
3658 a function called ``a'' treated as a mangled type name would be
3659 demangled to ``signed char''.
3663 Do not include implementation details (if any) in the demangled
3668 @itemx --recurse-limit
3669 @itemx --no-recurse-limit
3670 @itemx --recursion-limit
3671 @itemx --no-recursion-limit
3672 Enables or disables a limit on the amount of recursion performed
3673 whilst demangling strings. Since the name mangling formats allow for
3674 an inifinite level of recursion it is possible to create strings whose
3675 decoding will exhaust the amount of stack space available on the host
3676 machine, triggering a memory fault. The limit tries to prevent this
3677 from happening by restricting recursion to 2048 levels of nesting.
3679 The default is for this limit to be enabled, but disabling it may be
3680 necessary in order to demangle truly complicated names. Note however
3681 that if the recursion limit is disabled then stack exhaustion is
3682 possible and any bug reports about such an event will be rejected.
3684 The @option{-r} option is a synonym for the
3685 @option{--no-recurse-limit} option. The @option{-R} option is a
3686 synonym for the @option{--recurse-limit} option.
3688 @item -s @var{format}
3689 @itemx --format=@var{format}
3690 @command{c++filt} can decode various methods of mangling, used by
3691 different compilers. The argument to this option selects which
3696 Automatic selection based on executable (the default method)
3698 the one used by the @sc{gnu} C++ compiler (g++)
3700 the one used by the Lucid compiler (lcc)
3702 the one specified by the C++ Annotated Reference Manual
3704 the one used by the HP compiler (aCC)
3706 the one used by the EDG compiler
3708 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3710 the one used by the @sc{gnu} Java compiler (gcj)
3712 the one used by the @sc{gnu} Ada compiler (GNAT).
3716 Print a summary of the options to @command{c++filt} and exit.
3719 Print the version number of @command{c++filt} and exit.
3725 @c man begin SEEALSO cxxfilt
3726 the Info entries for @file{binutils}.
3731 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3732 user interface are subject to change in future releases. In particular,
3733 a command-line option may be required in the future to decode a name
3734 passed as an argument on the command line; in other words,
3737 c++filt @var{symbol}
3741 may in a future release become
3744 c++filt @var{option} @var{symbol}
3752 @cindex address to file name and line number
3754 @c man title addr2line convert addresses into file names and line numbers
3757 @c man begin SYNOPSIS addr2line
3758 addr2line [@option{-a}|@option{--addresses}]
3759 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3760 [@option{-C}|@option{--demangle}[=@var{style}]]
3761 [@option{-r}|@option{--no-recurse-limit}]
3762 [@option{-R}|@option{--recurse-limit}]
3763 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3764 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3765 [@option{-i}|@option{--inlines}]
3766 [@option{-p}|@option{--pretty-print}]
3767 [@option{-j}|@option{--section=}@var{name}]
3768 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3773 @c man begin DESCRIPTION addr2line
3775 @command{addr2line} translates addresses into file names and line numbers.
3776 Given an address in an executable or an offset in a section of a relocatable
3777 object, it uses the debugging information to figure out which file name and
3778 line number are associated with it.
3780 The executable or relocatable object to use is specified with the @option{-e}
3781 option. The default is the file @file{a.out}. The section in the relocatable
3782 object to use is specified with the @option{-j} option.
3784 @command{addr2line} has two modes of operation.
3786 In the first, hexadecimal addresses are specified on the command line,
3787 and @command{addr2line} displays the file name and line number for each
3790 In the second, @command{addr2line} reads hexadecimal addresses from
3791 standard input, and prints the file name and line number for each
3792 address on standard output. In this mode, @command{addr2line} may be used
3793 in a pipe to convert dynamically chosen addresses.
3795 The format of the output is @samp{FILENAME:LINENO}. By default
3796 each input address generates one line of output.
3798 Two options can generate additional lines before each
3799 @samp{FILENAME:LINENO} line (in that order).
3801 If the @option{-a} option is used then a line with the input address
3804 If the @option{-f} option is used, then a line with the
3805 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3806 containing the address.
3808 One option can generate additional lines after the
3809 @samp{FILENAME:LINENO} line.
3811 If the @option{-i} option is used and the code at the given address is
3812 present there because of inlining by the compiler then additional
3813 lines are displayed afterwards. One or two extra lines (if the
3814 @option{-f} option is used) are displayed for each inlined function.
3816 Alternatively if the @option{-p} option is used then each input
3817 address generates a single, long, output line containing the address,
3818 the function name, the file name and the line number. If the
3819 @option{-i} option has also been used then any inlined functions will
3820 be displayed in the same manner, but on separate lines, and prefixed
3821 by the text @samp{(inlined by)}.
3823 If the file name or function name can not be determined,
3824 @command{addr2line} will print two question marks in their place. If the
3825 line number can not be determined, @command{addr2line} will print 0.
3829 @c man begin OPTIONS addr2line
3831 The long and short forms of options, shown here as alternatives, are
3837 Display the address before the function name, file and line number
3838 information. The address is printed with a @samp{0x} prefix to easily
3841 @item -b @var{bfdname}
3842 @itemx --target=@var{bfdname}
3843 @cindex object code format
3844 Specify that the object-code format for the object files is
3848 @itemx --demangle[=@var{style}]
3849 @cindex demangling in objdump
3850 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3851 Besides removing any initial underscore prepended by the system, this
3852 makes C++ function names readable. Different compilers have different
3853 mangling styles. The optional demangling style argument can be used to
3854 choose an appropriate demangling style for your compiler. @xref{c++filt},
3855 for more information on demangling.
3857 @item -e @var{filename}
3858 @itemx --exe=@var{filename}
3859 Specify the name of the executable for which addresses should be
3860 translated. The default file is @file{a.out}.
3864 Display function names as well as file and line number information.
3868 Display only the base of each file name.
3872 If the address belongs to a function that was inlined, the source
3873 information for all enclosing scopes back to the first non-inlined
3874 function will also be printed. For example, if @code{main} inlines
3875 @code{callee1} which inlines @code{callee2}, and address is from
3876 @code{callee2}, the source information for @code{callee1} and @code{main}
3877 will also be printed.
3881 Read offsets relative to the specified section instead of absolute addresses.
3884 @itemx --pretty-print
3885 Make the output more human friendly: each location are printed on one line.
3886 If option @option{-i} is specified, lines for all enclosing scopes are
3887 prefixed with @samp{(inlined by)}.
3891 @itemx --recurse-limit
3892 @itemx --no-recurse-limit
3893 @itemx --recursion-limit
3894 @itemx --no-recursion-limit
3895 Enables or disables a limit on the amount of recursion performed
3896 whilst demangling strings. Since the name mangling formats allow for
3897 an inifinite level of recursion it is possible to create strings whose
3898 decoding will exhaust the amount of stack space available on the host
3899 machine, triggering a memory fault. The limit tries to prevent this
3900 from happening by restricting recursion to 2048 levels of nesting.
3902 The default is for this limit to be enabled, but disabling it may be
3903 necessary in order to demangle truly complicated names. Note however
3904 that if the recursion limit is disabled then stack exhaustion is
3905 possible and any bug reports about such an event will be rejected.
3907 The @option{-r} option is a synonym for the
3908 @option{--no-recurse-limit} option. The @option{-R} option is a
3909 synonym for the @option{--recurse-limit} option.
3911 Note this option is only effective if the @option{-C} or
3912 @option{--demangle} option has been enabled.
3919 @c man begin SEEALSO addr2line
3920 Info entries for @file{binutils}.
3927 @command{windmc} may be used to generator Windows message resources.
3930 @emph{Warning:} @command{windmc} is not always built as part of the binary
3931 utilities, since it is only useful for Windows targets.
3934 @c man title windmc generates Windows message resources
3937 @c man begin SYNOPSIS windmc
3938 windmc [options] input-file
3942 @c man begin DESCRIPTION windmc
3944 @command{windmc} reads message definitions from an input file (.mc) and
3945 translate them into a set of output files. The output files may be of
3950 A C header file containing the message definitions.
3953 A resource file compilable by the @command{windres} tool.
3956 One or more binary files containing the resource data for a specific
3960 A C include file that maps message id's to their symbolic name.
3963 The exact description of these different formats is available in
3964 documentation from Microsoft.
3966 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3967 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3968 Windows Message Compiler.
3972 @c man begin OPTIONS windmc
3977 Specifies that the input file specified is ASCII. This is the default
3982 Specifies that messages in the output @code{bin} files should be in ASCII
3987 Specifies that @code{bin} filenames should have to be prefixed by the
3988 basename of the source file.
3992 Sets the customer bit in all message id's.
3994 @item -C @var{codepage}
3995 @itemx --codepage_in @var{codepage}
3996 Sets the default codepage to be used to convert input file to UTF16. The
3997 default is ocdepage 1252.
4000 @itemx --decimal_values
4001 Outputs the constants in the header file in decimal. Default is using
4005 @itemx --extension @var{ext}
4006 The extension for the header file. The default is .h extension.
4008 @item -F @var{target}
4009 @itemx --target @var{target}
4010 Specify the BFD format to use for a bin file as output. This
4011 is a BFD target name; you can use the @option{--help} option to see a list
4012 of supported targets. Normally @command{windmc} will use the default
4013 format, which is the first one listed by the @option{--help} option.
4015 @ref{Target Selection}.
4019 @itemx --headerdir @var{path}
4020 The target directory of the generated header file. The default is the
4025 Displays a list of command-line options and then exits.
4027 @item -m @var{characters}
4028 @itemx --maxlength @var{characters}
4029 Instructs @command{windmc} to generate a warning if the length
4030 of any message exceeds the number specified.
4033 @itemx --nullterminate
4034 Terminate message text in @code{bin} files by zero. By default they are
4035 terminated by CR/LF.
4038 @itemx --hresult_use
4039 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
4040 file, using HRESULT definitions. Status codes are used if the flag is not
4043 @item -O @var{codepage}
4044 @itemx --codepage_out @var{codepage}
4045 Sets the default codepage to be used to output text files. The default
4049 @itemx --rcdir @var{path}
4050 The target directory for the generated @code{rc} script and the generated
4051 @code{bin} files that the resource compiler script includes. The default
4052 is the current directory.
4056 Specifies that the input file is UTF16.
4059 @itemx --unicode_out
4060 Specifies that messages in the output @code{bin} file should be in UTF16
4061 format. This is the default behaviour.
4065 Enable verbose mode.
4069 Prints the version number for @command{windmc}.
4072 @itemx --xdgb @var{path}
4073 The path of the @code{dbg} C include file that maps message id's to the
4074 symbolic name. No such file is generated without specifying the switch.
4080 @c man begin SEEALSO windmc
4081 the Info entries for @file{binutils}.
4088 @command{windres} may be used to manipulate Windows resources.
4091 @emph{Warning:} @command{windres} is not always built as part of the binary
4092 utilities, since it is only useful for Windows targets.
4095 @c man title windres manipulate Windows resources
4098 @c man begin SYNOPSIS windres
4099 windres [options] [input-file] [output-file]
4103 @c man begin DESCRIPTION windres
4105 @command{windres} reads resources from an input file and copies them into
4106 an output file. Either file may be in one of three formats:
4110 A text format read by the Resource Compiler.
4113 A binary format generated by the Resource Compiler.
4116 A COFF object or executable.
4119 The exact description of these different formats is available in
4120 documentation from Microsoft.
4122 When @command{windres} converts from the @code{rc} format to the @code{res}
4123 format, it is acting like the Windows Resource Compiler. When
4124 @command{windres} converts from the @code{res} format to the @code{coff}
4125 format, it is acting like the Windows @code{CVTRES} program.
4127 When @command{windres} generates an @code{rc} file, the output is similar
4128 but not identical to the format expected for the input. When an input
4129 @code{rc} file refers to an external filename, an output @code{rc} file
4130 will instead include the file contents.
4132 If the input or output format is not specified, @command{windres} will
4133 guess based on the file name, or, for the input file, the file contents.
4134 A file with an extension of @file{.rc} will be treated as an @code{rc}
4135 file, a file with an extension of @file{.res} will be treated as a
4136 @code{res} file, and a file with an extension of @file{.o} or
4137 @file{.exe} will be treated as a @code{coff} file.
4139 If no output file is specified, @command{windres} will print the resources
4140 in @code{rc} format to standard output.
4142 The normal use is for you to write an @code{rc} file, use @command{windres}
4143 to convert it to a COFF object file, and then link the COFF file into
4144 your application. This will make the resources described in the
4145 @code{rc} file available to Windows.
4149 @c man begin OPTIONS windres
4152 @item -i @var{filename}
4153 @itemx --input @var{filename}
4154 The name of the input file. If this option is not used, then
4155 @command{windres} will use the first non-option argument as the input file
4156 name. If there are no non-option arguments, then @command{windres} will
4157 read from standard input. @command{windres} can not read a COFF file from
4160 @item -o @var{filename}
4161 @itemx --output @var{filename}
4162 The name of the output file. If this option is not used, then
4163 @command{windres} will use the first non-option argument, after any used
4164 for the input file name, as the output file name. If there is no
4165 non-option argument, then @command{windres} will write to standard output.
4166 @command{windres} can not write a COFF file to standard output. Note,
4167 for compatibility with @command{rc} the option @option{-fo} is also
4168 accepted, but its use is not recommended.
4170 @item -J @var{format}
4171 @itemx --input-format @var{format}
4172 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4173 @samp{coff}. If no input format is specified, @command{windres} will
4174 guess, as described above.
4176 @item -O @var{format}
4177 @itemx --output-format @var{format}
4178 The output format to generate. @var{format} may be @samp{res},
4179 @samp{rc}, or @samp{coff}. If no output format is specified,
4180 @command{windres} will guess, as described above.
4182 @item -F @var{target}
4183 @itemx --target @var{target}
4184 Specify the BFD format to use for a COFF file as input or output. This
4185 is a BFD target name; you can use the @option{--help} option to see a list
4186 of supported targets. Normally @command{windres} will use the default
4187 format, which is the first one listed by the @option{--help} option.
4189 @ref{Target Selection}.
4192 @item --preprocessor @var{program}
4193 When @command{windres} reads an @code{rc} file, it runs it through the C
4194 preprocessor first. This option may be used to specify the preprocessor
4195 to use, including any leading arguments. The default preprocessor
4196 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4198 @item --preprocessor-arg @var{option}
4199 When @command{windres} reads an @code{rc} file, it runs it through
4200 the C preprocessor first. This option may be used to specify additional
4201 text to be passed to preprocessor on its command line.
4202 This option can be used multiple times to add multiple options to the
4203 preprocessor command line.
4205 @item -I @var{directory}
4206 @itemx --include-dir @var{directory}
4207 Specify an include directory to use when reading an @code{rc} file.
4208 @command{windres} will pass this to the preprocessor as an @option{-I}
4209 option. @command{windres} will also search this directory when looking for
4210 files named in the @code{rc} file. If the argument passed to this command
4211 matches any of the supported @var{formats} (as described in the @option{-J}
4212 option), it will issue a deprecation warning, and behave just like the
4213 @option{-J} option. New programs should not use this behaviour. If a
4214 directory happens to match a @var{format}, simple prefix it with @samp{./}
4215 to disable the backward compatibility.
4217 @item -D @var{target}
4218 @itemx --define @var{sym}[=@var{val}]
4219 Specify a @option{-D} option to pass to the preprocessor when reading an
4222 @item -U @var{target}
4223 @itemx --undefine @var{sym}
4224 Specify a @option{-U} option to pass to the preprocessor when reading an
4228 Ignored for compatibility with rc.
4231 Enable verbose mode. This tells you what the preprocessor is if you
4235 @item --codepage @var{val}
4236 Specify the default codepage to use when reading an @code{rc} file.
4237 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4238 codepage code. The valid range is from zero up to 0xffff, but the
4239 validity of the codepage is host and configuration dependent.
4242 @item --language @var{val}
4243 Specify the default language to use when reading an @code{rc} file.
4244 @var{val} should be a hexadecimal language code. The low eight bits are
4245 the language, and the high eight bits are the sublanguage.
4247 @item --use-temp-file
4248 Use a temporary file to instead of using popen to read the output of
4249 the preprocessor. Use this option if the popen implementation is buggy
4250 on the host (eg., certain non-English language versions of Windows 95 and
4251 Windows 98 are known to have buggy popen where the output will instead
4254 @item --no-use-temp-file
4255 Use popen, not a temporary file, to read the output of the preprocessor.
4256 This is the default behaviour.
4260 Prints a usage summary.
4264 Prints the version number for @command{windres}.
4267 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4268 this will turn on parser debugging.
4274 @c man begin SEEALSO windres
4275 the Info entries for @file{binutils}.
4284 @command{dlltool} is used to create the files needed to create dynamic
4285 link libraries (DLLs) on systems which understand PE format image
4286 files such as Windows. A DLL contains an export table which contains
4287 information that the runtime loader needs to resolve references from a
4288 referencing program.
4290 The export table is generated by this program by reading in a
4291 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4292 will be in the DLL. A @file{.o} file can contain information in
4293 special @samp{.drectve} sections with export information.
4296 @emph{Note:} @command{dlltool} is not always built as part of the
4297 binary utilities, since it is only useful for those targets which
4301 @c man title dlltool create files needed to build and use DLLs
4304 @c man begin SYNOPSIS dlltool
4305 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4306 [@option{-b}|@option{--base-file} @var{base-file-name}]
4307 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4308 [@option{-z}|@option{--output-def} @var{def-file-name}]
4309 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4310 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4311 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4312 [@option{--exclude-symbols} @var{list}]
4313 [@option{--no-default-excludes}]
4314 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4315 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4316 [@option{-a}|@option{--add-indirect}]
4317 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4318 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4319 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4320 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4321 [@option{--use-nul-prefixed-import-tables}]
4322 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4323 [@option{-i}|@option{--interwork}]
4324 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4325 [@option{-v}|@option{--verbose}]
4326 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4327 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4328 [object-file @dots{}]
4332 @c man begin DESCRIPTION dlltool
4334 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4335 @option{-b} options as well as object files specified on the command
4336 line. It then processes these inputs and if the @option{-e} option has
4337 been specified it creates a exports file. If the @option{-l} option
4338 has been specified it creates a library file and if the @option{-z} option
4339 has been specified it creates a def file. Any or all of the @option{-e},
4340 @option{-l} and @option{-z} options can be present in one invocation of
4343 When creating a DLL, along with the source for the DLL, it is necessary
4344 to have three other files. @command{dlltool} can help with the creation of
4347 The first file is a @file{.def} file which specifies which functions are
4348 exported from the DLL, which functions the DLL imports, and so on. This
4349 is a text file and can be created by hand, or @command{dlltool} can be used
4350 to create it using the @option{-z} option. In this case @command{dlltool}
4351 will scan the object files specified on its command line looking for
4352 those functions which have been specially marked as being exported and
4353 put entries for them in the @file{.def} file it creates.
4355 In order to mark a function as being exported from a DLL, it needs to
4356 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4357 section of the object file. This can be done in C by using the
4361 asm (".section .drectve");
4362 asm (".ascii \"-export:my_func\"");
4364 int my_func (void) @{ @dots{} @}
4367 The second file needed for DLL creation is an exports file. This file
4368 is linked with the object files that make up the body of the DLL and it
4369 handles the interface between the DLL and the outside world. This is a
4370 binary file and it can be created by giving the @option{-e} option to
4371 @command{dlltool} when it is creating or reading in a @file{.def} file.
4373 The third file needed for DLL creation is the library file that programs
4374 will link with in order to access the functions in the DLL (an `import
4375 library'). This file can be created by giving the @option{-l} option to
4376 dlltool when it is creating or reading in a @file{.def} file.
4378 If the @option{-y} option is specified, dlltool generates a delay-import
4379 library that can be used instead of the normal import library to allow
4380 a program to link to the dll only as soon as an imported function is
4381 called for the first time. The resulting executable will need to be
4382 linked to the static delayimp library containing __delayLoadHelper2(),
4383 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4385 @command{dlltool} builds the library file by hand, but it builds the
4386 exports file by creating temporary files containing assembler statements
4387 and then assembling these. The @option{-S} command-line option can be
4388 used to specify the path to the assembler that dlltool will use,
4389 and the @option{-f} option can be used to pass specific flags to that
4390 assembler. The @option{-n} can be used to prevent dlltool from deleting
4391 these temporary assembler files when it is done, and if @option{-n} is
4392 specified twice then this will prevent dlltool from deleting the
4393 temporary object files it used to build the library.
4395 Here is an example of creating a DLL from a source file @samp{dll.c} and
4396 also creating a program (from an object file called @samp{program.o})
4401 dlltool -e exports.o -l dll.lib dll.o
4402 gcc dll.o exports.o -o dll.dll
4403 gcc program.o dll.lib -o program
4407 @command{dlltool} may also be used to query an existing import library
4408 to determine the name of the DLL to which it is associated. See the
4409 description of the @option{-I} or @option{--identify} option.
4413 @c man begin OPTIONS dlltool
4415 The command-line options have the following meanings:
4419 @item -d @var{filename}
4420 @itemx --input-def @var{filename}
4421 @cindex input .def file
4422 Specifies the name of a @file{.def} file to be read in and processed.
4424 @item -b @var{filename}
4425 @itemx --base-file @var{filename}
4427 Specifies the name of a base file to be read in and processed. The
4428 contents of this file will be added to the relocation section in the
4429 exports file generated by dlltool.
4431 @item -e @var{filename}
4432 @itemx --output-exp @var{filename}
4433 Specifies the name of the export file to be created by dlltool.
4435 @item -z @var{filename}
4436 @itemx --output-def @var{filename}
4437 Specifies the name of the @file{.def} file to be created by dlltool.
4439 @item -l @var{filename}
4440 @itemx --output-lib @var{filename}
4441 Specifies the name of the library file to be created by dlltool.
4443 @item -y @var{filename}
4444 @itemx --output-delaylib @var{filename}
4445 Specifies the name of the delay-import library file to be created by dlltool.
4447 @item --export-all-symbols
4448 Treat all global and weak defined symbols found in the input object
4449 files as symbols to be exported. There is a small list of symbols which
4450 are not exported by default; see the @option{--no-default-excludes}
4451 option. You may add to the list of symbols to not export by using the
4452 @option{--exclude-symbols} option.
4454 @item --no-export-all-symbols
4455 Only export symbols explicitly listed in an input @file{.def} file or in
4456 @samp{.drectve} sections in the input object files. This is the default
4457 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4458 attributes in the source code.
4460 @item --exclude-symbols @var{list}
4461 Do not export the symbols in @var{list}. This is a list of symbol names
4462 separated by comma or colon characters. The symbol names should not
4463 contain a leading underscore. This is only meaningful when
4464 @option{--export-all-symbols} is used.
4466 @item --no-default-excludes
4467 When @option{--export-all-symbols} is used, it will by default avoid
4468 exporting certain special symbols. The current list of symbols to avoid
4469 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4470 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4471 to go ahead and export these special symbols. This is only meaningful
4472 when @option{--export-all-symbols} is used.
4475 @itemx --as @var{path}
4476 Specifies the path, including the filename, of the assembler to be used
4477 to create the exports file.
4479 @item -f @var{options}
4480 @itemx --as-flags @var{options}
4481 Specifies any specific command-line options to be passed to the
4482 assembler when building the exports file. This option will work even if
4483 the @option{-S} option is not used. This option only takes one argument,
4484 and if it occurs more than once on the command line, then later
4485 occurrences will override earlier occurrences. So if it is necessary to
4486 pass multiple options to the assembler they should be enclosed in
4490 @itemx --dll-name @var{name}
4491 Specifies the name to be stored in the @file{.def} file as the name of
4492 the DLL when the @option{-e} option is used. If this option is not
4493 present, then the filename given to the @option{-e} option will be
4494 used as the name of the DLL.
4496 @item -m @var{machine}
4497 @itemx -machine @var{machine}
4498 Specifies the type of machine for which the library file should be
4499 built. @command{dlltool} has a built in default type, depending upon how
4500 it was created, but this option can be used to override that. This is
4501 normally only useful when creating DLLs for an ARM processor, when the
4502 contents of the DLL are actually encode using Thumb instructions.
4505 @itemx --add-indirect
4506 Specifies that when @command{dlltool} is creating the exports file it
4507 should add a section which allows the exported functions to be
4508 referenced without using the import library. Whatever the hell that
4512 @itemx --add-underscore
4513 Specifies that when @command{dlltool} is creating the exports file it
4514 should prepend an underscore to the names of @emph{all} exported symbols.
4516 @item --no-leading-underscore
4517 @item --leading-underscore
4518 Specifies whether standard symbol should be forced to be prefixed, or
4521 @item --add-stdcall-underscore
4522 Specifies that when @command{dlltool} is creating the exports file it
4523 should prepend an underscore to the names of exported @emph{stdcall}
4524 functions. Variable names and non-stdcall function names are not modified.
4525 This option is useful when creating GNU-compatible import libs for third
4526 party DLLs that were built with MS-Windows tools.
4530 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4531 of stdcall functions that will be imported from the DLL. This is
4532 useful when creating an import library for a DLL which exports stdcall
4533 functions but without the usual @samp{@@<number>} symbol name suffix.
4535 This does not change the naming of symbols provided by the import library
4536 to programs linked against it, but only the entries in the import table
4537 (ie the .idata section).
4540 @itemx --add-stdcall-alias
4541 Specifies that when @command{dlltool} is creating the exports file it
4542 should add aliases for stdcall symbols without @samp{@@ <number>}
4543 in addition to the symbols with @samp{@@ <number>}.
4546 @itemx --ext-prefix-alias @var{prefix}
4547 Causes @command{dlltool} to create external aliases for all DLL
4548 imports with the specified prefix. The aliases are created for both
4549 external and import symbols with no leading underscore.
4553 Specifies that when @command{dlltool} is creating the exports and library
4554 files it should omit the @code{.idata4} section. This is for compatibility
4555 with certain operating systems.
4557 @item --use-nul-prefixed-import-tables
4558 Specifies that when @command{dlltool} is creating the exports and library
4559 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4560 element. This emulates old gnu import library generation of
4561 @code{dlltool}. By default this option is turned off.
4565 Specifies that when @command{dlltool} is creating the exports and library
4566 files it should omit the @code{.idata5} section. This is for compatibility
4567 with certain operating systems.
4569 @item -I @var{filename}
4570 @itemx --identify @var{filename}
4571 Specifies that @command{dlltool} should inspect the import library
4572 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4573 of the associated DLL(s). This can be performed in addition to any
4574 other operations indicated by the other options and arguments.
4575 @command{dlltool} fails if the import library does not exist or is not
4576 actually an import library. See also @option{--identify-strict}.
4578 @item --identify-strict
4579 Modifies the behavior of the @option{--identify} option, such
4580 that an error is reported if @var{filename} is associated with
4585 Specifies that @command{dlltool} should mark the objects in the library
4586 file and exports file that it produces as supporting interworking
4587 between ARM and Thumb code.
4591 Makes @command{dlltool} preserve the temporary assembler files it used to
4592 create the exports file. If this option is repeated then dlltool will
4593 also preserve the temporary object files it uses to create the library
4596 @item -t @var{prefix}
4597 @itemx --temp-prefix @var{prefix}
4598 Makes @command{dlltool} use @var{prefix} when constructing the names of
4599 temporary assembler and object files. By default, the temp file prefix
4600 is generated from the pid.
4604 Make dlltool describe what it is doing.
4608 Displays a list of command-line options and then exits.
4612 Displays dlltool's version number and then exits.
4619 * def file format:: The format of the dlltool @file{.def} file
4622 @node def file format
4623 @section The format of the @command{dlltool} @file{.def} file
4625 A @file{.def} file contains any number of the following commands:
4629 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4630 The result is going to be named @var{name}@code{.exe}.
4632 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4633 The result is going to be named @var{name}@code{.dll}.
4634 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4635 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4638 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4639 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4640 Declares @var{name1} as an exported symbol from the DLL, with optional
4641 ordinal number @var{integer}, or declares @var{name1} as an alias
4642 (forward) of the function @var{external-name} in the DLL.
4643 If @var{its_name} is specified, this name is used as string in export table.
4645 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4646 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4647 If you want to use LIBRARY as name then you need to quote it.
4649 @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{]} *}
4650 Declares that @var{external-name} or the exported function whose
4651 ordinal number is @var{integer} is to be imported from the file
4652 @var{module-name}. If @var{internal-name} is specified then this is
4653 the name that the imported function will be referred to in the body of
4655 If @var{its_name} is specified, this name is used as string in import table.
4656 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4657 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4658 If you want to use LIBRARY as name then you need to quote it.
4660 @item @code{DESCRIPTION} @var{string}
4661 Puts @var{string} into the output @file{.exp} file in the
4662 @code{.rdata} section.
4664 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4665 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4666 Generates @code{--stack} or @code{--heap}
4667 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4668 section. The linker will see this and act upon it.
4670 @item @code{CODE} @var{attr} @code{+}
4671 @item @code{DATA} @var{attr} @code{+}
4672 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4673 Generates @code{--attr} @var{section-name} @var{attr} in the output
4674 @code{.drectve} section, where @var{attr} is one of @code{READ},
4675 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4676 this and act upon it.
4681 @c man begin SEEALSO dlltool
4682 The Info pages for @file{binutils}.
4689 @cindex ELF file information
4692 @c man title readelf display information about ELF files
4695 @c man begin SYNOPSIS readelf
4696 readelf [@option{-a}|@option{--all}]
4697 [@option{-h}|@option{--file-header}]
4698 [@option{-l}|@option{--program-headers}|@option{--segments}]
4699 [@option{-S}|@option{--section-headers}|@option{--sections}]
4700 [@option{-g}|@option{--section-groups}]
4701 [@option{-t}|@option{--section-details}]
4702 [@option{-e}|@option{--headers}]
4703 [@option{-s}|@option{--syms}|@option{--symbols}]
4704 [@option{--dyn-syms}]
4705 [@option{-n}|@option{--notes}]
4706 [@option{-r}|@option{--relocs}]
4707 [@option{-u}|@option{--unwind}]
4708 [@option{-d}|@option{--dynamic}]
4709 [@option{-V}|@option{--version-info}]
4710 [@option{-A}|@option{--arch-specific}]
4711 [@option{-D}|@option{--use-dynamic}]
4712 [@option{-L}|@option{--lint}|@option{--enable-checks}]
4713 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4714 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4715 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4716 [@option{-z}|@option{--decompress}]
4717 [@option{-c}|@option{--archive-index}]
4718 [@option{-w[lLiaprmfFsoORtUuTgAckK]}|
4719 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
4720 [@option{--dwarf-depth=@var{n}}]
4721 [@option{--dwarf-start=@var{n}}]
4722 [@option{--ctf=}@var{section}]
4723 [@option{--ctf-parent=}@var{section}]
4724 [@option{--ctf-symbols=}@var{section}]
4725 [@option{--ctf-strings=}@var{section}]
4726 [@option{-I}|@option{--histogram}]
4727 [@option{-v}|@option{--version}]
4728 [@option{-W}|@option{--wide}]
4729 [@option{-T}|@option{--silent-truncation}]
4730 [@option{-H}|@option{--help}]
4731 @var{elffile}@dots{}
4735 @c man begin DESCRIPTION readelf
4737 @command{readelf} displays information about one or more ELF format object
4738 files. The options control what particular information to display.
4740 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4741 64-bit ELF files are supported, as are archives containing ELF files.
4743 This program performs a similar function to @command{objdump} but it
4744 goes into more detail and it exists independently of the @sc{bfd}
4745 library, so if there is a bug in @sc{bfd} then readelf will not be
4750 @c man begin OPTIONS readelf
4752 The long and short forms of options, shown here as alternatives, are
4753 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4759 Equivalent to specifying @option{--file-header},
4760 @option{--program-headers}, @option{--sections}, @option{--symbols},
4761 @option{--relocs}, @option{--dynamic}, @option{--notes},
4762 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
4763 @option{--section-groups} and @option{--histogram}.
4765 Note - this option does not enable @option{--use-dynamic} itself, so
4766 if that option is not present on the command line then dynamic symbols
4767 and dynamic relocs will not be displayed.
4770 @itemx --file-header
4771 @cindex ELF file header information
4772 Displays the information contained in the ELF header at the start of the
4776 @itemx --program-headers
4778 @cindex ELF program header information
4779 @cindex ELF segment information
4780 Displays the information contained in the file's segment headers, if it
4785 @itemx --section-headers
4786 @cindex ELF section information
4787 Displays the information contained in the file's section headers, if it
4791 @itemx --section-groups
4792 @cindex ELF section group information
4793 Displays the information contained in the file's section groups, if it
4797 @itemx --section-details
4798 @cindex ELF section information
4799 Displays the detailed section information. Implies @option{-S}.
4804 @cindex ELF symbol table information
4805 Displays the entries in symbol table section of the file, if it has one.
4806 If a symbol has version information associated with it then this is
4807 displayed as well. The version string is displayed as a suffix to the
4808 symbol name, preceeded by an @@ character. For example
4809 @samp{foo@@VER_1}. If the version is the default version to be used
4810 when resolving unversioned references to the symbol then it is
4811 displayed as a suffix preceeded by two @@ characters. For example
4812 @samp{foo@@@@VER_2}.
4815 @cindex ELF dynamic symbol table information
4816 Displays the entries in dynamic symbol table section of the file, if it
4817 has one. The output format is the same as the format used by the
4818 @option{--syms} option.
4822 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4827 Displays the contents of the NOTE segments and/or sections, if any.
4831 @cindex ELF reloc information
4832 Displays the contents of the file's relocation section, if it has one.
4836 @cindex unwind information
4837 Displays the contents of the file's unwind section, if it has one. Only
4838 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4839 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. If
4840 support is not yet implemented for your architecture you could try
4841 dumping the contents of the @var{.eh_frames} section using the
4842 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
4847 @cindex ELF dynamic section information
4848 Displays the contents of the file's dynamic section, if it has one.
4851 @itemx --version-info
4852 @cindex ELF version sections information
4853 Displays the contents of the version sections in the file, it they
4857 @itemx --arch-specific
4858 Displays architecture-specific information in the file, if there
4862 @itemx --use-dynamic
4863 When displaying symbols, this option makes @command{readelf} use the
4864 symbol hash tables in the file's dynamic section, rather than the
4865 symbol table sections.
4867 When displaying relocations, this option makes @command{readelf}
4868 display the dynamic relocations rather than the static relocations.
4872 @itemx --enable-checks
4873 Displays warning messages about possible problems with the file(s)
4874 being examined. If used on its own then all of the contents of the
4875 file(s) will be examined. If used with one of the dumping options
4876 then the warning messages will only be produced for the things being
4879 @item -x <number or name>
4880 @itemx --hex-dump=<number or name>
4881 Displays the contents of the indicated section as a hexadecimal bytes.
4882 A number identifies a particular section by index in the section table;
4883 any other string identifies all sections with that name in the object file.
4885 @item -R <number or name>
4886 @itemx --relocated-dump=<number or name>
4887 Displays the contents of the indicated section as a hexadecimal
4888 bytes. A number identifies a particular section by index in the
4889 section table; any other string identifies all sections with that name
4890 in the object file. The contents of the section will be relocated
4891 before they are displayed.
4893 @item -p <number or name>
4894 @itemx --string-dump=<number or name>
4895 Displays the contents of the indicated section as printable strings.
4896 A number identifies a particular section by index in the section table;
4897 any other string identifies all sections with that name in the object file.
4901 Requests that the section(s) being dumped by @option{x}, @option{R} or
4902 @option{p} options are decompressed before being displayed. If the
4903 section(s) are not compressed then they are displayed as is.
4906 @itemx --archive-index
4907 @cindex Archive file symbol index information
4908 Displays the file symbol index information contained in the header part
4909 of binary archives. Performs the same function as the @option{t}
4910 command to @command{ar}, but without using the BFD library. @xref{ar}.
4912 @item -w[lLiaprmfFsOoRtUuTgAckK]
4913 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
4914 @include debug.options.texi
4916 @include ctf.options.texi
4917 @item --ctf-symbols=@var{section}
4918 @item --ctf-strings=@var{section}
4919 Specify the name of another section from which the CTF file can inherit
4920 strings and symbols. By default, the @code{.symtab} and its linked
4921 string table are used.
4923 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
4924 other must be specified as well.
4928 Display a histogram of bucket list lengths when displaying the contents
4929 of the symbol tables.
4933 Display the version number of readelf.
4937 Don't break output lines to fit into 80 columns. By default
4938 @command{readelf} breaks section header and segment listing lines for
4939 64-bit ELF files, so that they fit into 80 columns. This option causes
4940 @command{readelf} to print each section header resp. each segment one a
4941 single line, which is far more readable on terminals wider than 80 columns.
4944 @itemx --silent-truncation
4945 Normally when readelf is displaying a symbol name, and it has to
4946 truncate the name to fit into an 80 column display, it will add a
4947 suffix of @code{[...]} to the name. This command line option
4948 disables this behaviour, allowing 5 more characters of the name to be
4949 displayed and restoring the old behaviour of readelf (prior to release
4954 Display the command-line options understood by @command{readelf}.
4961 @c man begin SEEALSO readelf
4962 objdump(1), and the Info entries for @file{binutils}.
4969 @cindex Update ELF header
4972 @c man title elfedit update ELF header and program property of ELF files
4975 @c man begin SYNOPSIS elfedit
4976 elfedit [@option{--input-mach=}@var{machine}]
4977 [@option{--input-type=}@var{type}]
4978 [@option{--input-osabi=}@var{osabi}]
4979 @option{--output-mach=}@var{machine}
4980 @option{--output-type=}@var{type}
4981 @option{--output-osabi=}@var{osabi}
4982 @option{--enable-x86-feature=}@var{feature}
4983 @option{--disable-x86-feature=}@var{feature}
4984 [@option{-v}|@option{--version}]
4985 [@option{-h}|@option{--help}]
4986 @var{elffile}@dots{}
4990 @c man begin DESCRIPTION elfedit
4992 @command{elfedit} updates the ELF header and program property of ELF
4993 files which have the matching ELF machine and file types. The options
4994 control how and which fields in the ELF header and program property
4997 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4998 64-bit ELF files are supported, as are archives containing ELF files.
5001 @c man begin OPTIONS elfedit
5003 The long and short forms of options, shown here as alternatives, are
5004 equivalent. At least one of the @option{--output-mach},
5005 @option{--output-type}, @option{--output-osabi},
5006 @option{--enable-x86-feature} and @option{--disable-x86-feature}
5007 options must be given.
5011 @item --input-mach=@var{machine}
5012 Set the matching input ELF machine type to @var{machine}. If
5013 @option{--input-mach} isn't specified, it will match any ELF
5016 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
5017 @var{K1OM} and @var{x86-64}.
5019 @item --output-mach=@var{machine}
5020 Change the ELF machine type in the ELF header to @var{machine}. The
5021 supported ELF machine types are the same as @option{--input-mach}.
5023 @item --input-type=@var{type}
5024 Set the matching input ELF file type to @var{type}. If
5025 @option{--input-type} isn't specified, it will match any ELF file types.
5027 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
5029 @item --output-type=@var{type}
5030 Change the ELF file type in the ELF header to @var{type}. The
5031 supported ELF types are the same as @option{--input-type}.
5033 @item --input-osabi=@var{osabi}
5034 Set the matching input ELF file OSABI to @var{osabi}. If
5035 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
5037 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
5038 @var{GNU}, @var{Linux} (alias for @var{GNU}),
5039 @var{Solaris}, @var{AIX}, @var{Irix},
5040 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
5041 @var{NSK}, @var{AROS} and @var{FenixOS}.
5043 @item --output-osabi=@var{osabi}
5044 Change the ELF OSABI in the ELF header to @var{osabi}. The
5045 supported ELF OSABI are the same as @option{--input-osabi}.
5047 @item --enable-x86-feature=@var{feature}
5048 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
5049 ELF files with machine types of @var{i386} or @var{x86-64}. The
5050 supported features are, @var{ibt} and @var{shstk}.
5052 @item --disable-x86-feature=@var{feature}
5053 Clear the @var{feature} bit in program property in @var{exec} or
5054 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
5055 The supported features are the same as @option{--enable-x86-feature}.
5057 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
5058 are available only on hosts with @samp{mmap} support.
5062 Display the version number of @command{elfedit}.
5066 Display the command-line options understood by @command{elfedit}.
5073 @c man begin SEEALSO elfedit
5074 readelf(1), and the Info entries for @file{binutils}.
5078 @node Common Options
5079 @chapter Common Options
5081 The following command-line options are supported by all of the
5082 programs described in this manual.
5084 @c man begin OPTIONS
5086 @include at-file.texi
5090 Display the command-line options supported by the program.
5093 Display the version number of the program.
5095 @c man begin OPTIONS
5099 @node Selecting the Target System
5100 @chapter Selecting the Target System
5102 You can specify two aspects of the target system to the @sc{gnu}
5103 binary file utilities, each in several ways:
5113 In the following summaries, the lists of ways to specify values are in
5114 order of decreasing precedence. The ways listed first override those
5117 The commands to list valid values only list the values for which the
5118 programs you are running were configured. If they were configured with
5119 @option{--enable-targets=all}, the commands list most of the available
5120 values, but a few are left out; not all targets can be configured in at
5121 once because some of them can only be configured @dfn{native} (on hosts
5122 with the same type as the target system).
5125 * Target Selection::
5126 * Architecture Selection::
5129 @node Target Selection
5130 @section Target Selection
5132 A @dfn{target} is an object file format. A given target may be
5133 supported for multiple architectures (@pxref{Architecture Selection}).
5134 A target selection may also have variations for different operating
5135 systems or architectures.
5137 The command to list valid target values is @samp{objdump -i}
5138 (the first column of output contains the relevant information).
5140 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5141 @samp{a.out-sunos-big}.
5143 You can also specify a target using a configuration triplet. This is
5144 the same sort of name that is passed to @file{configure} to specify a
5145 target. When you use a configuration triplet as an argument, it must be
5146 fully canonicalized. You can see the canonical version of a triplet by
5147 running the shell script @file{config.sub} which is included with the
5150 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5151 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5153 @subheading @command{objdump} Target
5159 command-line option: @option{-b} or @option{--target}
5162 environment variable @code{GNUTARGET}
5165 deduced from the input file
5168 @subheading @command{objcopy} and @command{strip} Input Target
5174 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5177 environment variable @code{GNUTARGET}
5180 deduced from the input file
5183 @subheading @command{objcopy} and @command{strip} Output Target
5189 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5192 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5195 environment variable @code{GNUTARGET}
5198 deduced from the input file
5201 @subheading @command{nm}, @command{size}, and @command{strings} Target
5207 command-line option: @option{--target}
5210 environment variable @code{GNUTARGET}
5213 deduced from the input file
5216 @node Architecture Selection
5217 @section Architecture Selection
5219 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5220 to run. Its name may contain a colon, separating the name of the
5221 processor family from the name of the particular @sc{cpu}.
5223 The command to list valid architecture values is @samp{objdump -i} (the
5224 second column contains the relevant information).
5226 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5228 @subheading @command{objdump} Architecture
5234 command-line option: @option{-m} or @option{--architecture}
5237 deduced from the input file
5240 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5246 deduced from the input file
5251 @cindex separate debug files
5253 debuginfod is a web service that indexes ELF/DWARF debugging resources
5254 by build-id and serves them over HTTP.
5256 Binutils can be built with the debuginfod client library
5257 @code{libdebuginfod} using the @option{--with-debuginfod} configure option.
5258 This option is enabled by default if @code{libdebuginfod} is installed
5259 and found at configure time. This allows @command{objdump} and
5260 @command{readelf} to automatically query debuginfod servers for
5261 separate debug files when the files are otherwise not found.
5263 debuginfod is packaged with elfutils, starting with version 0.178.
5264 You can get the latest version from `https://sourceware.org/elfutils/'.
5266 @node Reporting Bugs
5267 @chapter Reporting Bugs
5269 @cindex reporting bugs
5271 Your bug reports play an essential role in making the binary utilities
5274 Reporting a bug may help you by bringing a solution to your problem, or
5275 it may not. But in any case the principal function of a bug report is
5276 to help the entire community by making the next version of the binary
5277 utilities work better. Bug reports are your contribution to their
5280 In order for a bug report to serve its purpose, you must include the
5281 information that enables us to fix the bug.
5284 * Bug Criteria:: Have you found a bug?
5285 * Bug Reporting:: How to report bugs
5289 @section Have You Found a Bug?
5290 @cindex bug criteria
5292 If you are not sure whether you have found a bug, here are some guidelines:
5295 @cindex fatal signal
5298 If a binary utility gets a fatal signal, for any input whatever, that is
5299 a bug. Reliable utilities never crash.
5301 @cindex error on valid input
5303 If a binary utility produces an error message for valid input, that is a
5307 If you are an experienced user of binary utilities, your suggestions for
5308 improvement are welcome in any case.
5312 @section How to Report Bugs
5314 @cindex bugs, reporting
5316 A number of companies and individuals offer support for @sc{gnu}
5317 products. If you obtained the binary utilities from a support
5318 organization, we recommend you contact that organization first.
5320 You can find contact information for many support companies and
5321 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5325 In any event, we also recommend that you send bug reports for the binary
5326 utilities to @value{BUGURL}.
5329 The fundamental principle of reporting bugs usefully is this:
5330 @strong{report all the facts}. If you are not sure whether to state a
5331 fact or leave it out, state it!
5333 Often people omit facts because they think they know what causes the
5334 problem and assume that some details do not matter. Thus, you might
5335 assume that the name of a file you use in an example does not matter.
5336 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5337 a stray memory reference which happens to fetch from the location where
5338 that pathname is stored in memory; perhaps, if the pathname were
5339 different, the contents of that location would fool the utility into
5340 doing the right thing despite the bug. Play it safe and give a
5341 specific, complete example. That is the easiest thing for you to do,
5342 and the most helpful.
5344 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5345 it is new to us. Therefore, always write your bug reports on the assumption
5346 that the bug has not been reported previously.
5348 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5349 bell?'' This cannot help us fix a bug, so it is basically useless. We
5350 respond by asking for enough details to enable us to investigate.
5351 You might as well expedite matters by sending them to begin with.
5353 To enable us to fix the bug, you should include all these things:
5357 The version of the utility. Each utility announces it if you start it
5358 with the @option{--version} argument.
5360 Without this, we will not know whether there is any point in looking for
5361 the bug in the current version of the binary utilities.
5364 Any patches you may have applied to the source, including any patches
5365 made to the @code{BFD} library.
5368 The type of machine you are using, and the operating system name and
5372 What compiler (and its version) was used to compile the utilities---e.g.
5376 The command arguments you gave the utility to observe the bug. To
5377 guarantee you will not omit something important, list them all. A copy
5378 of the Makefile (or the output from make) is sufficient.
5380 If we were to try to guess the arguments, we would probably guess wrong
5381 and then we might not encounter the bug.
5384 A complete input file, or set of input files, that will reproduce the
5385 bug. If the utility is reading an object file or files, then it is
5386 generally most helpful to send the actual object files.
5388 If the source files were produced exclusively using @sc{gnu} programs
5389 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5390 may be OK to send the source files rather than the object files. In
5391 this case, be sure to say exactly what version of @command{gcc}, or
5392 whatever, was used to produce the object files. Also say how
5393 @command{gcc}, or whatever, was configured.
5396 A description of what behavior you observe that you believe is
5397 incorrect. For example, ``It gets a fatal signal.''
5399 Of course, if the bug is that the utility gets a fatal signal, then we
5400 will certainly notice it. But if the bug is incorrect output, we might
5401 not notice unless it is glaringly wrong. You might as well not give us
5402 a chance to make a mistake.
5404 Even if the problem you experience is a fatal signal, you should still
5405 say so explicitly. Suppose something strange is going on, such as your
5406 copy of the utility is out of sync, or you have encountered a bug in
5407 the C library on your system. (This has happened!) Your copy might
5408 crash and ours would not. If you told us to expect a crash, then when
5409 ours fails to crash, we would know that the bug was not happening for
5410 us. If you had not told us to expect a crash, then we would not be able
5411 to draw any conclusion from our observations.
5414 If you wish to suggest changes to the source, send us context diffs, as
5415 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5416 option. Always send diffs from the old file to the new file. If you
5417 wish to discuss something in the @command{ld} source, refer to it by
5418 context, not by line number.
5420 The line numbers in our development sources will not match those in your
5421 sources. Your line numbers would convey no useful information to us.
5424 Here are some things that are not necessary:
5428 A description of the envelope of the bug.
5430 Often people who encounter a bug spend a lot of time investigating
5431 which changes to the input file will make the bug go away and which
5432 changes will not affect it.
5434 This is often time consuming and not very useful, because the way we
5435 will find the bug is by running a single example under the debugger
5436 with breakpoints, not by pure deduction from a series of examples.
5437 We recommend that you save your time for something else.
5439 Of course, if you can find a simpler example to report @emph{instead}
5440 of the original one, that is a convenience for us. Errors in the
5441 output will be easier to spot, running under the debugger will take
5442 less time, and so on.
5444 However, simplification is not vital; if you do not want to do this,
5445 report the bug anyway and send us the entire test case you used.
5448 A patch for the bug.
5450 A patch for the bug does help us if it is a good one. But do not omit
5451 the necessary information, such as the test case, on the assumption that
5452 a patch is all we need. We might see problems with your patch and decide
5453 to fix the problem another way, or we might not understand it at all.
5455 Sometimes with programs as complicated as the binary utilities it is
5456 very hard to construct an example that will make the program follow a
5457 certain path through the code. If you do not send us the example, we
5458 will not be able to construct one, so we will not be able to verify that
5461 And if we cannot understand what bug you are trying to fix, or why your
5462 patch should be an improvement, we will not install it. A test case will
5463 help us to understand.
5466 A guess about what the bug is or what it depends on.
5468 Such guesses are usually wrong. Even we cannot guess right about such
5469 things without first using the debugger to find the facts.
5472 @node GNU Free Documentation License
5473 @appendix GNU Free Documentation License
5477 @node Binutils Index
5478 @unnumbered Binutils Index