1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2020 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.3
17 or any later version published by the Free Software Foundation;
18 with no Invariant Sections, with no Front-Cover Texts, and with no
19 Back-Cover Texts. A copy of the license is included in the
20 section entitled ``GNU Free Documentation License''.
25 @dircategory Software development
27 * Binutils: (binutils). The GNU binary utilities.
30 @dircategory Individual utilities
32 * addr2line: (binutils)addr2line. Convert addresses to file and line.
33 * ar: (binutils)ar. Create, modify, and extract from archives.
34 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
35 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
36 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
37 * nm: (binutils)nm. List symbols from object files.
38 * objcopy: (binutils)objcopy. Copy and translate object files.
39 * objdump: (binutils)objdump. Display information from object files.
40 * ranlib: (binutils)ranlib. Generate index to archive contents.
41 * readelf: (binutils)readelf. Display the contents of ELF format files.
42 * size: (binutils)size. List section sizes and total size.
43 * strings: (binutils)strings. List printable strings from files.
44 * strip: (binutils)strip. Discard symbols.
45 * elfedit: (binutils)elfedit. Update ELF header and property of ELF files.
46 * windmc: (binutils)windmc. Generator for Windows message resources.
47 * windres: (binutils)windres. Manipulate Windows resources.
51 @title The @sc{gnu} Binary Utilities
52 @ifset VERSION_PACKAGE
53 @subtitle @value{VERSION_PACKAGE}
55 @subtitle Version @value{VERSION}
57 @subtitle @value{UPDATED}
58 @author Roland H. Pesch
59 @author Jeffrey M. Osier
60 @author Cygnus Support
64 {\parskip=0pt \hfill Cygnus Support\par \hfill
65 Texinfo \texinfoversion\par }
68 @vskip 0pt plus 1filll
77 This brief manual contains documentation for the @sc{gnu} binary
79 @ifset VERSION_PACKAGE
80 @value{VERSION_PACKAGE}
82 version @value{VERSION}:
87 Create, modify, and extract from archives
90 List symbols from object files
93 Copy and translate object files
96 Display information from object files
99 Generate index to archive contents
102 Display the contents of ELF format files.
105 List file section sizes and total size
108 List printable strings from files
114 Update the ELF header and program property of ELF files.
117 Demangle encoded C++ symbols (on MS-DOS, this program is named
121 Convert addresses into file names and line numbers
124 Manipulate Windows resources
127 Generator for Windows message resources
130 Create the files needed to build and use Dynamic Link Libraries
134 This document is distributed under the terms of the GNU Free
135 Documentation License version 1.3. A copy of the license is included
136 in the section entitled ``GNU Free Documentation License''.
139 * ar:: Create, modify, and extract from archives
140 * nm:: List symbols from object files
141 * objcopy:: Copy and translate object files
142 * objdump:: Display information from object files
143 * ranlib:: Generate index to archive contents
144 * size:: List section sizes and total size
145 * strings:: List printable strings from files
146 * strip:: Discard symbols
147 * c++filt:: Filter to demangle encoded C++ symbols
148 * cxxfilt: c++filt. MS-DOS name for c++filt
149 * addr2line:: Convert addresses to file and line
150 * windmc:: Generator for Windows message resources
151 * windres:: Manipulate Windows resources
152 * dlltool:: Create files needed to build and use DLLs
153 * readelf:: Display the contents of ELF format files
154 * elfedit:: Update ELF header and property of ELF files
155 * Common Options:: Command-line options for all utilities
156 * Selecting the Target System:: How these utilities determine the target
157 * debuginfod:: Using binutils with debuginfod
158 * Reporting Bugs:: Reporting Bugs
159 * GNU Free Documentation License:: GNU Free Documentation License
160 * Binutils Index:: Binutils Index
168 @cindex collections of files
170 @c man title ar create, modify, and extract from archives
173 ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
174 ar -M [ <mri-script ]
177 @c man begin DESCRIPTION ar
179 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
180 archives. An @dfn{archive} is a single file holding a collection of
181 other files in a structure that makes it possible to retrieve
182 the original individual files (called @dfn{members} of the archive).
184 The original files' contents, mode (permissions), timestamp, owner, and
185 group are preserved in the archive, and can be restored on
189 @sc{gnu} @command{ar} can maintain archives whose members have names of any
190 length; however, depending on how @command{ar} is configured on your
191 system, a limit on member-name length may be imposed for compatibility
192 with archive formats maintained with other tools. If it exists, the
193 limit is often 15 characters (typical of formats related to a.out) or 16
194 characters (typical of formats related to coff).
197 @command{ar} is considered a binary utility because archives of this sort
198 are most often used as @dfn{libraries} holding commonly needed
202 @command{ar} creates an index to the symbols defined in relocatable
203 object modules in the archive when you specify the modifier @samp{s}.
204 Once created, this index is updated in the archive whenever @command{ar}
205 makes a change to its contents (save for the @samp{q} update operation).
206 An archive with such an index speeds up linking to the library, and
207 allows routines in the library to call each other without regard to
208 their placement in the archive.
210 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
211 table. If an archive lacks the table, another form of @command{ar} called
212 @command{ranlib} can be used to add just the table.
214 @cindex thin archives
215 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
216 which contains a symbol index and references to the original copies
217 of the member files of the archive. This is useful for building
218 libraries for use within a local build tree, where the relocatable
219 objects are expected to remain available, and copying the contents of
220 each object would only waste time and space.
222 An archive can either be @emph{thin} or it can be normal. It cannot
223 be both at the same time. Once an archive is created its format
224 cannot be changed without first deleting it and then creating a new
225 archive in its place.
227 Thin archives are also @emph{flattened}, so that adding one thin
228 archive to another thin archive does not nest it, as would happen with
229 a normal archive. Instead the elements of the first archive are added
230 individually to the second archive.
232 The paths to the elements of the archive are stored relative to the
235 @cindex compatibility, @command{ar}
236 @cindex @command{ar} compatibility
237 @sc{gnu} @command{ar} is designed to be compatible with two different
238 facilities. You can control its activity using command-line options,
239 like the different varieties of @command{ar} on Unix systems; or, if you
240 specify the single command-line option @option{-M}, you can control it
241 with a script supplied via standard input, like the MRI ``librarian''
247 * ar cmdline:: Controlling @command{ar} on the command line
248 * ar scripts:: Controlling @command{ar} with a script
253 @section Controlling @command{ar} on the Command Line
256 @c man begin SYNOPSIS ar
257 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
261 @cindex Unix compatibility, @command{ar}
262 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
263 arguments to execute: one keyletter specifying the @emph{operation}
264 (optionally accompanied by other keyletters specifying
265 @emph{modifiers}), and the archive name to act on.
267 Most operations can also accept further @var{member} arguments,
268 specifying particular files to operate on.
270 @c man begin OPTIONS ar
272 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
273 flags @var{mod} in any order, within the first command-line argument.
275 If you wish, you may begin the first command-line argument with a
278 @cindex operations on archive
279 The @var{p} keyletter specifies what operation to execute; it may be
280 any of the following, but you must specify only one of them:
284 @cindex deleting from archive
285 @emph{Delete} modules from the archive. Specify the names of modules to
286 be deleted as @var{member}@dots{}; the archive is untouched if you
287 specify no files to delete.
289 If you specify the @samp{v} modifier, @command{ar} lists each module
293 @cindex moving in archive
294 Use this operation to @emph{move} members in an archive.
296 The ordering of members in an archive can make a difference in how
297 programs are linked using the library, if a symbol is defined in more
300 If no modifiers are used with @code{m}, any members you name in the
301 @var{member} arguments are moved to the @emph{end} of the archive;
302 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
303 specified place instead.
306 @cindex printing from archive
307 @emph{Print} the specified members of the archive, to the standard
308 output file. If the @samp{v} modifier is specified, show the member
309 name before copying its contents to standard output.
311 If you specify no @var{member} arguments, all the files in the archive are
315 @cindex quick append to archive
316 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
317 @var{archive}, without checking for replacement.
319 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
320 operation; new members are always placed at the end of the archive.
322 The modifier @samp{v} makes @command{ar} list each file as it is appended.
324 Since the point of this operation is speed, implementations of
325 @command{ar} have the option of not updating the archive's symbol
326 table if one exists. Too many different systems however assume that
327 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
328 rebuild the table even with a quick append.
330 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
331 synonym for @samp{r} - replacing already existing files in the
332 archive and appending new ones at the end.
335 @cindex replacement in archive
336 Insert the files @var{member}@dots{} into @var{archive} (with
337 @emph{replacement}). This operation differs from @samp{q} in that any
338 previously existing members are deleted if their names match those being
341 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
342 displays an error message, and leaves undisturbed any existing members
343 of the archive matching that name.
345 By default, new members are added at the end of the file; but you may
346 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
347 placement relative to some existing member.
349 The modifier @samp{v} used with this operation elicits a line of
350 output for each file inserted, along with one of the letters @samp{a} or
351 @samp{r} to indicate whether the file was appended (no old member
352 deleted) or replaced.
356 Add an index to the archive, or update it if it already exists. Note
357 this command is an exception to the rule that there can only be one
358 command letter, as it is possible to use it as either a command or a
359 modifier. In either case it does the same thing.
362 @cindex contents of archive
363 Display a @emph{table} listing the contents of @var{archive}, or those
364 of the files listed in @var{member}@dots{} that are present in the
365 archive. Normally only the member name is shown, but if the modifier
366 @samp{O} is specified, then the corresponding offset of the member is also
367 displayed. Finally, in order to see the modes (permissions), timestamp,
368 owner, group, and size the @samp{v} modifier should be included.
370 If you do not specify a @var{member}, all files in the archive
373 @cindex repeated names in archive
374 @cindex name duplication in archive
375 If there is more than one file with the same name (say, @samp{fie}) in
376 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
377 first instance; to see them all, you must ask for a complete
378 listing---in our example, @samp{ar t b.a}.
379 @c WRS only; per Gumby, this is implementation-dependent, and in a more
380 @c recent case in fact works the other way.
383 @cindex extract from archive
384 @emph{Extract} members (named @var{member}) from the archive. You can
385 use the @samp{v} modifier with this operation, to request that
386 @command{ar} list each name as it extracts it.
388 If you do not specify a @var{member}, all files in the archive
391 Files cannot be extracted from a thin archive, and there are
392 restrictions on extracting from archives created with @option{P}: The
393 paths must not be absolute, may not contain @code{..}, and any
394 subdirectories in the paths must exist. If it is desired to avoid
395 these restrictions then used the @option{--output} option to specify
399 A number of modifiers (@var{mod}) may immediately follow the @var{p}
400 keyletter, to specify variations on an operation's behavior:
404 @cindex relative placement in archive
405 Add new files @emph{after} an existing member of the
406 archive. If you use the modifier @samp{a}, the name of an existing archive
407 member must be present as the @var{relpos} argument, before the
408 @var{archive} specification.
411 Add new files @emph{before} an existing member of the
412 archive. If you use the modifier @samp{b}, the name of an existing archive
413 member must be present as the @var{relpos} argument, before the
414 @var{archive} specification. (same as @samp{i}).
417 @cindex creating archives
418 @emph{Create} the archive. The specified @var{archive} is always
419 created if it did not exist, when you request an update. But a warning is
420 issued unless you specify in advance that you expect to create it, by
424 @cindex deterministic archives
425 @kindex --enable-deterministic-archives
426 Operate in @emph{deterministic} mode. When adding files and the archive
427 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
428 for all files. When this option is used, if @command{ar} is used with
429 identical options and identical input files, multiple runs will create
430 identical output files regardless of the input files' owners, groups,
431 file modes, or modification times.
433 If @file{binutils} was configured with
434 @option{--enable-deterministic-archives}, then this mode is on by default.
435 It can be disabled with the @samp{U} modifier, below.
438 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
439 names of any length. This will cause it to create archives which are
440 not compatible with the native @command{ar} program on some systems. If
441 this is a concern, the @samp{f} modifier may be used to truncate file
442 names when putting them in the archive.
445 Insert new files @emph{before} an existing member of the
446 archive. If you use the modifier @samp{i}, the name of an existing archive
447 member must be present as the @var{relpos} argument, before the
448 @var{archive} specification. (same as @samp{b}).
451 This modifier is accepted but not used.
452 @c whaffor ar l modifier??? presumably compat; with
453 @c what???---doc@@cygnus.com, 25jan91
456 Uses the @var{count} parameter. This is used if there are multiple
457 entries in the archive with the same name. Extract or delete instance
458 @var{count} of the given name from the archive.
461 @cindex dates in archive
462 Preserve the @emph{original} dates of members when extracting them. If
463 you do not specify this modifier, files extracted from the archive
464 are stamped with the time of extraction.
467 @cindex offsets of files
468 Display member offsets inside the archive. Use together with the @samp{t}
472 Use the full path name when matching or storing names in the archive.
473 Archives created with full path names are not POSIX compliant, and
474 thus may not work with tools other than up to date @sc{gnu} tools.
475 Modifying such archives with @sc{gnu} @command{ar} without using
476 @option{P} will remove the full path names unless the archive is a
477 thin archive. Note that @option{P} may be useful when adding files to
478 a thin archive since @option{r} without @option{P} ignores the path
479 when choosing which element to replace. Thus
481 ar rcST archive.a subdir/file1 subdir/file2 file1
483 will result in the first @code{subdir/file1} being replaced with
484 @code{file1} from the current directory. Adding @option{P} will
485 prevent this replacement.
488 @cindex writing archive index
489 Write an object-file index into the archive, or update an existing one,
490 even if no other change is made to the archive. You may use this modifier
491 flag either with any operation, or alone. Running @samp{ar s} on an
492 archive is equivalent to running @samp{ranlib} on it.
495 @cindex not writing archive index
496 Do not generate an archive symbol table. This can speed up building a
497 large library in several steps. The resulting archive can not be used
498 with the linker. In order to build a symbol table, you must omit the
499 @samp{S} modifier on the last execution of @samp{ar}, or you must run
500 @samp{ranlib} on the archive.
503 @cindex creating thin archive
504 Make the specified @var{archive} a @emph{thin} archive. If it already
505 exists and is a regular archive, the existing members must be present
506 in the same directory as @var{archive}.
509 @cindex updating an archive
510 Normally, @samp{ar r}@dots{} inserts all files
511 listed into the archive. If you would like to insert @emph{only} those
512 of the files you list that are newer than existing members of the same
513 names, use this modifier. The @samp{u} modifier is allowed only for the
514 operation @samp{r} (replace). In particular, the combination @samp{qu} is
515 not allowed, since checking the timestamps would lose any speed
516 advantage from the operation @samp{q}.
519 @cindex deterministic archives
520 @kindex --enable-deterministic-archives
521 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
522 of the @samp{D} modifier, above: added files and the archive index will
523 get their actual UID, GID, timestamp, and file mode values.
525 This is the default unless @file{binutils} was configured with
526 @option{--enable-deterministic-archives}.
529 This modifier requests the @emph{verbose} version of an operation. Many
530 operations display additional information, such as filenames processed,
531 when the modifier @samp{v} is appended.
534 This modifier shows the version number of @command{ar}.
537 The @command{ar} program also supports some command-line options which
538 are neither modifiers nor actions, but which do change its behaviour
543 Displays the list of command-line options supported by @command{ar}
547 Displays the version information of @command{ar} and then exits.
550 @command{ar} ignores an initial option spelled @samp{-X32_64}, for
551 compatibility with AIX. The behaviour produced by this option is the
552 default for @sc{gnu} @command{ar}. @command{ar} does not support any
553 of the other @samp{-X} options; in particular, it does not support
554 @option{-X32} which is the default for AIX @command{ar}.
556 @item --plugin @var{name}
558 The optional command-line switch @option{--plugin @var{name}} causes
559 @command{ar} to load the plugin called @var{name} which adds support
560 for more file formats, including object files with link-time
561 optimization information.
563 This option is only available if the toolchain has been built with
564 plugin support enabled.
566 If @option{--plugin} is not provided, but plugin support has been
567 enabled then @command{ar} iterates over the files in
568 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
569 plugin that claims the object in question is used.
571 Please note that this plugin search directory is @emph{not} the one
572 used by @command{ld}'s @option{-plugin} option. In order to make
573 @command{ar} use the linker plugin it must be copied into the
574 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
575 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
576 based compilations it is called @file{LLVMgold.so}. The GCC plugin
577 is always backwards compatible with earlier versions, so it is
578 sufficient to just copy the newest one.
580 @item --target @var{target}
581 The optional command-line switch @option{--target @var{bfdname}}
582 specifies that the archive members are in an object code format
583 different from your system's default format. See
584 @xref{Target Selection}, for more information.
586 @item --output @var{dirname}
587 The @option{--output} option can be used to specify a path to a
588 directory into which archive members should be extracted. If this
589 option is not specified then the current directory will be used.
591 Note - although the presence of this option does imply a @option{x}
592 extraction operation that option must still be included on the command
599 @c man begin SEEALSO ar
600 nm(1), ranlib(1), and the Info entries for @file{binutils}.
605 @section Controlling @command{ar} with a Script
608 ar -M [ <@var{script} ]
611 @cindex MRI compatibility, @command{ar}
612 @cindex scripts, @command{ar}
613 If you use the single command-line option @samp{-M} with @command{ar}, you
614 can control its operation with a rudimentary command language. This
615 form of @command{ar} operates interactively if standard input is coming
616 directly from a terminal. During interactive use, @command{ar} prompts for
617 input (the prompt is @samp{AR >}), and continues executing even after
618 errors. If you redirect standard input to a script file, no prompts are
619 issued, and @command{ar} abandons execution (with a nonzero exit code)
622 The @command{ar} command language is @emph{not} designed to be equivalent
623 to the command-line options; in fact, it provides somewhat less control
624 over archives. The only purpose of the command language is to ease the
625 transition to @sc{gnu} @command{ar} for developers who already have scripts
626 written for the MRI ``librarian'' program.
628 The syntax for the @command{ar} command language is straightforward:
631 commands are recognized in upper or lower case; for example, @code{LIST}
632 is the same as @code{list}. In the following descriptions, commands are
633 shown in upper case for clarity.
636 a single command may appear on each line; it is the first word on the
640 empty lines are allowed, and have no effect.
643 comments are allowed; text after either of the characters @samp{*}
644 or @samp{;} is ignored.
647 Whenever you use a list of names as part of the argument to an @command{ar}
648 command, you can separate the individual names with either commas or
649 blanks. Commas are shown in the explanations below, for clarity.
652 @samp{+} is used as a line continuation character; if @samp{+} appears
653 at the end of a line, the text on the following line is considered part
654 of the current command.
657 Here are the commands you can use in @command{ar} scripts, or when using
658 @command{ar} interactively. Three of them have special significance:
660 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
661 a temporary file required for most of the other commands.
663 @code{SAVE} commits the changes so far specified by the script. Prior
664 to @code{SAVE}, commands affect only the temporary copy of the current
668 @item ADDLIB @var{archive}
669 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
670 Add all the contents of @var{archive} (or, if specified, each named
671 @var{module} from @var{archive}) to the current archive.
673 Requires prior use of @code{OPEN} or @code{CREATE}.
675 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
676 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
677 @c else like "ar q..."
678 Add each named @var{member} as a module in the current archive.
680 Requires prior use of @code{OPEN} or @code{CREATE}.
683 Discard the contents of the current archive, canceling the effect of
684 any operations since the last @code{SAVE}. May be executed (with no
685 effect) even if no current archive is specified.
687 @item CREATE @var{archive}
688 Creates an archive, and makes it the current archive (required for many
689 other commands). The new archive is created with a temporary name; it
690 is not actually saved as @var{archive} until you use @code{SAVE}.
691 You can overwrite existing archives; similarly, the contents of any
692 existing file named @var{archive} will not be destroyed until @code{SAVE}.
694 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
695 Delete each listed @var{module} from the current archive; equivalent to
696 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
698 Requires prior use of @code{OPEN} or @code{CREATE}.
700 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
701 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
702 List each named @var{module} present in @var{archive}. The separate
703 command @code{VERBOSE} specifies the form of the output: when verbose
704 output is off, output is like that of @samp{ar -t @var{archive}
705 @var{module}@dots{}}. When verbose output is on, the listing is like
706 @samp{ar -tv @var{archive} @var{module}@dots{}}.
708 Output normally goes to the standard output stream; however, if you
709 specify @var{outputfile} as a final argument, @command{ar} directs the
713 Exit from @command{ar}, with a @code{0} exit code to indicate successful
714 completion. This command does not save the output file; if you have
715 changed the current archive since the last @code{SAVE} command, those
718 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
719 Extract each named @var{module} from the current archive, writing them
720 into the current directory as separate files. Equivalent to @samp{ar -x
721 @var{archive} @var{module}@dots{}}.
723 Requires prior use of @code{OPEN} or @code{CREATE}.
726 @c FIXME Tokens but no commands???
733 Display full contents of the current archive, in ``verbose'' style
734 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
735 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
736 enhancement, rather than present for MRI compatibility.)
738 Requires prior use of @code{OPEN} or @code{CREATE}.
740 @item OPEN @var{archive}
741 Opens an existing archive for use as the current archive (required for
742 many other commands). Any changes as the result of subsequent commands
743 will not actually affect @var{archive} until you next use @code{SAVE}.
745 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
746 In the current archive, replace each existing @var{module} (named in
747 the @code{REPLACE} arguments) from files in the current working directory.
748 To execute this command without errors, both the file, and the module in
749 the current archive, must exist.
751 Requires prior use of @code{OPEN} or @code{CREATE}.
754 Toggle an internal flag governing the output from @code{DIRECTORY}.
755 When the flag is on, @code{DIRECTORY} output matches output from
756 @samp{ar -tv }@dots{}.
759 Commit your changes to the current archive, and actually save it as a
760 file with the name specified in the last @code{CREATE} or @code{OPEN}
763 Requires prior use of @code{OPEN} or @code{CREATE}.
772 The @sc{gnu} linker @command{ld} is now described in a separate manual.
773 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
781 @c man title nm list symbols from object files
784 @c man begin SYNOPSIS nm
785 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
786 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
787 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
788 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
789 [@option{-l}|@option{--line-numbers}] [@option{--inlines}]
790 [@option{-n}|@option{-v}|@option{--numeric-sort}]
791 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
792 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
793 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
794 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
795 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
796 [@option{--plugin} @var{name}]
797 [@option{--no-recurse-limit}|@option{--recurse-limit}]]
798 [@option{--size-sort}] [@option{--special-syms}]
799 [@option{--synthetic}] [@option{--with-symbol-versions}] [@option{--target=}@var{bfdname}]
800 [@var{objfile}@dots{}]
804 @c man begin DESCRIPTION nm
805 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
806 If no object files are listed as arguments, @command{nm} assumes the file
809 For each symbol, @command{nm} shows:
813 The symbol value, in the radix selected by options (see below), or
814 hexadecimal by default.
817 The symbol type. At least the following types are used; others are, as
818 well, depending on the object file format. If lowercase, the symbol is
819 usually local; if uppercase, the symbol is global (external). There
820 are however a few lowercase symbols that are shown for special global
821 symbols (@code{u}, @code{v} and @code{w}).
823 @c Some more detail on exactly what these symbol types are used for
827 The symbol's value is absolute, and will not be changed by further
832 The symbol is in the BSS data section. This section typically
833 contains zero-initialized or uninitialized data, although the exact
834 behavior is system dependent.
837 The symbol is common. Common symbols are uninitialized data. When
838 linking, multiple common symbols may appear with the same name. If the
839 symbol is defined anywhere, the common symbols are treated as undefined
842 For more details on common symbols, see the discussion of
843 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
848 The symbol is in the initialized data section.
852 The symbol is in an initialized data section for small objects. Some
853 object file formats permit more efficient access to small data objects,
854 such as a global int variable as opposed to a large global array.
857 For PE format files this indicates that the symbol is in a section
858 specific to the implementation of DLLs. For ELF format files this
859 indicates that the symbol is an indirect function. This is a GNU
860 extension to the standard set of ELF symbol types. It indicates a
861 symbol which if referenced by a relocation does not evaluate to its
862 address, but instead must be invoked at runtime. The runtime
863 execution will then return the value to be used in the relocation.
866 The symbol is an indirect reference to another symbol.
869 The symbol is a debugging symbol.
872 The symbol is in the read-only data section.
875 The symbol is in a stack unwind section.
879 The symbol is in a read only data section.
883 The symbol is in an uninitialized or zero-initialized data section
888 The symbol is in the text (code) section.
891 The symbol is undefined.
894 The symbol is a unique global symbol. This is a GNU extension to the
895 standard set of ELF symbol bindings. For such a symbol the dynamic linker
896 will make sure that in the entire process there is just one symbol with
897 this name and type in use.
901 The symbol is a weak object. When a weak defined symbol is linked with
902 a normal defined symbol, the normal defined symbol is used with no error.
903 When a weak undefined symbol is linked and the symbol is not defined,
904 the value of the weak symbol becomes zero with no error. On some
905 systems, uppercase indicates that a default value has been specified.
909 The symbol is a weak symbol that has not been specifically tagged as a
910 weak object symbol. When a weak defined symbol is linked with a normal
911 defined symbol, the normal defined symbol is used with no error.
912 When a weak undefined symbol is linked and the symbol is not defined,
913 the value of the symbol is determined in a system-specific manner without
914 error. On some systems, uppercase indicates that a default value has been
918 The symbol is a stabs symbol in an a.out object file. In this case, the
919 next values printed are the stabs other field, the stabs desc field, and
920 the stab type. Stabs symbols are used to hold debugging information.
923 The symbol type is unknown, or object file format specific.
932 @c man begin OPTIONS nm
933 The long and short forms of options, shown here as alternatives, are
939 @itemx --print-file-name
940 @cindex input file name
942 @cindex source file name
943 Precede each symbol by the name of the input file (or archive member)
944 in which it was found, rather than identifying the input file once only,
945 before all of its symbols.
949 @cindex debugging symbols
950 Display all symbols, even debugger-only symbols; normally these are not
954 @cindex @command{nm} format
955 @cindex @command{nm} compatibility
956 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
959 @itemx --demangle[=@var{style}]
960 @cindex demangling in nm
961 Decode (@dfn{demangle}) low-level symbol names into user-level names.
962 Besides removing any initial underscore prepended by the system, this
963 makes C++ function names readable. Different compilers have different
964 mangling styles. The optional demangling style argument can be used to
965 choose an appropriate demangling style for your compiler. @xref{c++filt},
966 for more information on demangling.
969 Do not demangle low-level symbol names. This is the default.
971 @item --recurse-limit
972 @itemx --no-recurse-limit
973 @itemx --recursion-limit
974 @itemx --no-recursion-limit
975 Enables or disables a limit on the amount of recursion performed
976 whilst demangling strings. Since the name mangling formats allow for
977 an inifinite level of recursion it is possible to create strings whose
978 decoding will exhaust the amount of stack space available on the host
979 machine, triggering a memory fault. The limit tries to prevent this
980 from happening by restricting recursion to 2048 levels of nesting.
982 The default is for this limit to be enabled, but disabling it may be
983 necessary in order to demangle truly complicated names. Note however
984 that if the recursion limit is disabled then stack exhaustion is
985 possible and any bug reports about such an event will be rejected.
989 @cindex dynamic symbols
990 Display the dynamic symbols rather than the normal symbols. This is
991 only meaningful for dynamic objects, such as certain types of shared
994 @item -f @var{format}
995 @itemx --format=@var{format}
996 @cindex @command{nm} format
997 @cindex @command{nm} compatibility
998 Use the output format @var{format}, which can be @code{bsd},
999 @code{sysv}, or @code{posix}. The default is @code{bsd}.
1000 Only the first character of @var{format} is significant; it can be
1001 either upper or lower case.
1004 @itemx --extern-only
1005 @cindex external symbols
1006 Display only external symbols.
1010 Show a summary of the options to @command{nm} and exit.
1013 @itemx --line-numbers
1014 @cindex symbol line numbers
1015 For each symbol, use debugging information to try to find a filename and
1016 line number. For a defined symbol, look for the line number of the
1017 address of the symbol. For an undefined symbol, look for the line
1018 number of a relocation entry which refers to the symbol. If line number
1019 information can be found, print it after the other symbol information.
1022 @cindex objdump inlines
1023 When option @option{-l} is active, if the address belongs to a
1024 function that was inlined, then this option causes the source
1025 information for all enclosing scopes back to the first non-inlined
1026 function to be printed as well. For example, if @code{main} inlines
1027 @code{callee1} which inlines @code{callee2}, and address is from
1028 @code{callee2}, the source information for @code{callee1} and @code{main}
1029 will also be printed.
1033 @itemx --numeric-sort
1034 Sort symbols numerically by their addresses, rather than alphabetically
1039 @cindex sorting symbols
1040 Do not bother to sort the symbols in any order; print them in the order
1044 @itemx --portability
1045 Use the POSIX.2 standard output format instead of the default format.
1046 Equivalent to @samp{-f posix}.
1049 @itemx --reverse-sort
1050 Reverse the order of the sort (whether numeric or alphabetic); let the
1055 Print both value and size of defined symbols for the @code{bsd} output style.
1056 This option has no effect for object formats that do not record symbol
1057 sizes, unless @samp{--size-sort} is also used in which case a
1058 calculated size is displayed.
1061 @itemx --print-armap
1062 @cindex symbol index, listing
1063 When listing symbols from archive members, include the index: a mapping
1064 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
1065 contain definitions for which names.
1067 @item -t @var{radix}
1068 @itemx --radix=@var{radix}
1069 Use @var{radix} as the radix for printing the symbol values. It must be
1070 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
1073 @itemx --undefined-only
1074 @cindex external symbols
1075 @cindex undefined symbols
1076 Display only undefined symbols (those external to each object file).
1080 Show the version number of @command{nm} and exit.
1083 This option is ignored for compatibility with the AIX version of
1084 @command{nm}. It takes one parameter which must be the string
1085 @option{32_64}. The default mode of AIX @command{nm} corresponds
1086 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1088 @item --defined-only
1089 @cindex external symbols
1090 @cindex undefined symbols
1091 Display only defined symbols for each object file.
1093 @item --plugin @var{name}
1095 Load the plugin called @var{name} to add support for extra target
1096 types. This option is only available if the toolchain has been built
1097 with plugin support enabled.
1099 If @option{--plugin} is not provided, but plugin support has been
1100 enabled then @command{nm} iterates over the files in
1101 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
1102 plugin that claims the object in question is used.
1104 Please note that this plugin search directory is @emph{not} the one
1105 used by @command{ld}'s @option{-plugin} option. In order to make
1106 @command{nm} use the linker plugin it must be copied into the
1107 @file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
1108 the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
1109 based compilations it is called @file{LLVMgold.so}. The GCC plugin
1110 is always backwards compatible with earlier versions, so it is
1111 sufficient to just copy the newest one.
1114 Sort symbols by size. For ELF objects symbol sizes are read from the
1115 ELF, for other object types the symbol sizes are computed as the
1116 difference between the value of the symbol and the value of the symbol
1117 with the next higher value. If the @code{bsd} output format is used
1118 the size of the symbol is printed, rather than the value, and
1119 @samp{-S} must be used in order both size and value to be printed.
1121 @item --special-syms
1122 Display symbols which have a target-specific special meaning. These
1123 symbols are usually used by the target for some special processing and
1124 are not normally helpful when included in the normal symbol lists.
1125 For example for ARM targets this option would skip the mapping symbols
1126 used to mark transitions between ARM code, THUMB code and data.
1129 Include synthetic symbols in the output. These are special symbols
1130 created by the linker for various purposes. They are not shown by
1131 default since they are not part of the binary's original source code.
1133 @item --with-symbol-versions
1134 Enables the display of symbol version information if any exists. The
1135 version string is displayed as a suffix to the symbol name, preceeded by
1136 an @@ character. For example @samp{foo@@VER_1}. If the version is
1137 the default version to be used when resolving unversioned references
1138 to the symbol then it is displayed as a suffix preceeded by two @@
1139 characters. For example @samp{foo@@@@VER_2}.
1141 @item --target=@var{bfdname}
1142 @cindex object code format
1143 Specify an object code format other than your system's default format.
1144 @xref{Target Selection}, for more information.
1151 @c man begin SEEALSO nm
1152 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1159 @c man title objcopy copy and translate object files
1162 @c man begin SYNOPSIS objcopy
1163 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1164 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1165 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1166 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1167 [@option{-S}|@option{--strip-all}]
1168 [@option{-g}|@option{--strip-debug}]
1169 [@option{--strip-unneeded}]
1170 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1171 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1172 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1173 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1174 [@option{--localize-hidden}]
1175 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1176 [@option{--globalize-symbol=}@var{symbolname}]
1177 [@option{--globalize-symbols=}@var{filename}]
1178 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1179 [@option{-w}|@option{--wildcard}]
1180 [@option{-x}|@option{--discard-all}]
1181 [@option{-X}|@option{--discard-locals}]
1182 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1183 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1184 [@option{--interleave-width=}@var{width}]
1185 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1186 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1187 [@option{--keep-section=}@var{sectionpattern}]
1188 [@option{--remove-relocations=}@var{sectionpattern}]
1189 [@option{-p}|@option{--preserve-dates}]
1190 [@option{-D}|@option{--enable-deterministic-archives}]
1191 [@option{-U}|@option{--disable-deterministic-archives}]
1192 [@option{--debugging}]
1193 [@option{--gap-fill=}@var{val}]
1194 [@option{--pad-to=}@var{address}]
1195 [@option{--set-start=}@var{val}]
1196 [@option{--adjust-start=}@var{incr}]
1197 [@option{--change-addresses=}@var{incr}]
1198 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1199 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1200 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1201 [@option{--change-warnings}] [@option{--no-change-warnings}]
1202 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1203 [@option{--set-section-alignment} @var{sectionpattern}=@var{align}]
1204 [@option{--add-section} @var{sectionname}=@var{filename}]
1205 [@option{--dump-section} @var{sectionname}=@var{filename}]
1206 [@option{--update-section} @var{sectionname}=@var{filename}]
1207 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1208 [@option{--long-section-names} @{enable,disable,keep@}]
1209 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1210 [@option{--reverse-bytes=}@var{num}]
1211 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1212 [@option{--redefine-sym} @var{old}=@var{new}]
1213 [@option{--redefine-syms=}@var{filename}]
1215 [@option{--keep-symbols=}@var{filename}]
1216 [@option{--strip-symbols=}@var{filename}]
1217 [@option{--strip-unneeded-symbols=}@var{filename}]
1218 [@option{--keep-global-symbols=}@var{filename}]
1219 [@option{--localize-symbols=}@var{filename}]
1220 [@option{--weaken-symbols=}@var{filename}]
1221 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]]
1222 [@option{--alt-machine-code=}@var{index}]
1223 [@option{--prefix-symbols=}@var{string}]
1224 [@option{--prefix-sections=}@var{string}]
1225 [@option{--prefix-alloc-sections=}@var{string}]
1226 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1227 [@option{--keep-file-symbols}]
1228 [@option{--only-keep-debug}]
1229 [@option{--strip-dwo}]
1230 [@option{--extract-dwo}]
1231 [@option{--extract-symbol}]
1232 [@option{--writable-text}]
1233 [@option{--readonly-text}]
1236 [@option{--file-alignment=}@var{num}]
1237 [@option{--heap=}@var{size}]
1238 [@option{--image-base=}@var{address}]
1239 [@option{--section-alignment=}@var{num}]
1240 [@option{--stack=}@var{size}]
1241 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1242 [@option{--compress-debug-sections}]
1243 [@option{--decompress-debug-sections}]
1244 [@option{--elf-stt-common=@var{val}}]
1245 [@option{--merge-notes}]
1246 [@option{--no-merge-notes}]
1247 [@option{--verilog-data-width=@var{val}}]
1248 [@option{-v}|@option{--verbose}]
1249 [@option{-V}|@option{--version}]
1250 [@option{--help}] [@option{--info}]
1251 @var{infile} [@var{outfile}]
1255 @c man begin DESCRIPTION objcopy
1256 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1257 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1258 read and write the object files. It can write the destination object
1259 file in a format different from that of the source object file. The
1260 exact behavior of @command{objcopy} is controlled by command-line options.
1261 Note that @command{objcopy} should be able to copy a fully linked file
1262 between any two formats. However, copying a relocatable object file
1263 between any two formats may not work as expected.
1265 @command{objcopy} creates temporary files to do its translations and
1266 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1267 translation work; it has access to all the formats described in @sc{bfd}
1268 and thus is able to recognize most formats without being told
1269 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1271 @command{objcopy} can be used to generate S-records by using an output
1272 target of @samp{srec} (e.g., use @samp{-O srec}).
1274 @command{objcopy} can be used to generate a raw binary file by using an
1275 output target of @samp{binary} (e.g., use @option{-O binary}). When
1276 @command{objcopy} generates a raw binary file, it will essentially produce
1277 a memory dump of the contents of the input object file. All symbols and
1278 relocation information will be discarded. The memory dump will start at
1279 the load address of the lowest section copied into the output file.
1281 When generating an S-record or a raw binary file, it may be helpful to
1282 use @option{-S} to remove sections containing debugging information. In
1283 some cases @option{-R} will be useful to remove sections which contain
1284 information that is not needed by the binary file.
1286 Note---@command{objcopy} is not able to change the endianness of its input
1287 files. If the input format has an endianness (some formats do not),
1288 @command{objcopy} can only copy the inputs into file formats that have the
1289 same endianness or which have no endianness (e.g., @samp{srec}).
1290 (However, see the @option{--reverse-bytes} option.)
1294 @c man begin OPTIONS objcopy
1298 @itemx @var{outfile}
1299 The input and output files, respectively.
1300 If you do not specify @var{outfile}, @command{objcopy} creates a
1301 temporary file and destructively renames the result with
1302 the name of @var{infile}.
1304 @item -I @var{bfdname}
1305 @itemx --input-target=@var{bfdname}
1306 Consider the source file's object format to be @var{bfdname}, rather than
1307 attempting to deduce it. @xref{Target Selection}, for more information.
1309 @item -O @var{bfdname}
1310 @itemx --output-target=@var{bfdname}
1311 Write the output file using the object format @var{bfdname}.
1312 @xref{Target Selection}, for more information.
1314 @item -F @var{bfdname}
1315 @itemx --target=@var{bfdname}
1316 Use @var{bfdname} as the object format for both the input and the output
1317 file; i.e., simply transfer data from source to destination with no
1318 translation. @xref{Target Selection}, for more information.
1320 @item -B @var{bfdarch}
1321 @itemx --binary-architecture=@var{bfdarch}
1322 Useful when transforming a architecture-less input file into an object file.
1323 In this case the output architecture can be set to @var{bfdarch}. This
1324 option will be ignored if the input file has a known @var{bfdarch}. You
1325 can access this binary data inside a program by referencing the special
1326 symbols that are created by the conversion process. These symbols are
1327 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1328 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1329 an object file and then access it in your code using these symbols.
1331 @item -j @var{sectionpattern}
1332 @itemx --only-section=@var{sectionpattern}
1333 Copy only the indicated sections from the input file to the output file.
1334 This option may be given more than once. Note that using this option
1335 inappropriately may make the output file unusable. Wildcard
1336 characters are accepted in @var{sectionpattern}.
1338 If the first character of @var{sectionpattern} is the exclamation
1339 point (!) then matching sections will not be copied, even if earlier
1340 use of @option{--only-section} on the same command line would
1341 otherwise copy it. For example:
1344 --only-section=.text.* --only-section=!.text.foo
1347 will copy all sectinos maching '.text.*' but not the section
1350 @item -R @var{sectionpattern}
1351 @itemx --remove-section=@var{sectionpattern}
1352 Remove any section matching @var{sectionpattern} from the output file.
1353 This option may be given more than once. Note that using this option
1354 inappropriately may make the output file unusable. Wildcard
1355 characters are accepted in @var{sectionpattern}. Using both the
1356 @option{-j} and @option{-R} options together results in undefined
1359 If the first character of @var{sectionpattern} is the exclamation
1360 point (!) then matching sections will not be removed even if an
1361 earlier use of @option{--remove-section} on the same command line
1362 would otherwise remove it. For example:
1365 --remove-section=.text.* --remove-section=!.text.foo
1368 will remove all sections matching the pattern '.text.*', but will not
1369 remove the section '.text.foo'.
1371 @item --keep-section=@var{sectionpattern}
1372 When removing sections from the output file, keep sections that match
1373 @var{sectionpattern}.
1375 @item --remove-relocations=@var{sectionpattern}
1376 Remove non-dynamic relocations from the output file for any section
1377 matching @var{sectionpattern}. This option may be given more than
1378 once. Note that using this option inappropriately may make the output
1379 file unusable, and attempting to remove a dynamic relocation section
1380 such as @samp{.rela.plt} from an executable or shared library with
1381 @option{--remove-relocations=.plt} will not work. Wildcard characters
1382 are accepted in @var{sectionpattern}.
1386 --remove-relocations=.text.*
1389 will remove the relocations for all sections matching the pattern
1392 If the first character of @var{sectionpattern} is the exclamation
1393 point (!) then matching sections will not have their relocation
1394 removed even if an earlier use of @option{--remove-relocations} on the
1395 same command line would otherwise cause the relocations to be removed.
1399 --remove-relocations=.text.* --remove-relocations=!.text.foo
1402 will remove all relocations for sections matching the pattern
1403 '.text.*', but will not remove relocations for the section
1408 Do not copy relocation and symbol information from the source file.
1411 @itemx --strip-debug
1412 Do not copy debugging symbols or sections from the source file.
1414 @item --strip-unneeded
1415 Strip all symbols that are not needed for relocation processing.
1417 @item -K @var{symbolname}
1418 @itemx --keep-symbol=@var{symbolname}
1419 When stripping symbols, keep symbol @var{symbolname} even if it would
1420 normally be stripped. This option may be given more than once.
1422 @item -N @var{symbolname}
1423 @itemx --strip-symbol=@var{symbolname}
1424 Do not copy symbol @var{symbolname} from the source file. This option
1425 may be given more than once.
1427 @item --strip-unneeded-symbol=@var{symbolname}
1428 Do not copy symbol @var{symbolname} from the source file unless it is needed
1429 by a relocation. This option may be given more than once.
1431 @item -G @var{symbolname}
1432 @itemx --keep-global-symbol=@var{symbolname}
1433 Keep only symbol @var{symbolname} global. Make all other symbols local
1434 to the file, so that they are not visible externally. This option may
1435 be given more than once. Note: this option cannot be used in
1436 conjunction with the @option{--globalize-symbol} or
1437 @option{--globalize-symbols} options.
1439 @item --localize-hidden
1440 In an ELF object, mark all symbols that have hidden or internal visibility
1441 as local. This option applies on top of symbol-specific localization options
1442 such as @option{-L}.
1444 @item -L @var{symbolname}
1445 @itemx --localize-symbol=@var{symbolname}
1446 Convert a global or weak symbol called @var{symbolname} into a local
1447 symbol, so that it is not visible externally. This option may be
1448 given more than once. Note - unique symbols are not converted.
1450 @item -W @var{symbolname}
1451 @itemx --weaken-symbol=@var{symbolname}
1452 Make symbol @var{symbolname} weak. This option may be given more than once.
1454 @item --globalize-symbol=@var{symbolname}
1455 Give symbol @var{symbolname} global scoping so that it is visible
1456 outside of the file in which it is defined. This option may be given
1457 more than once. Note: this option cannot be used in conjunction with
1458 the @option{-G} or @option{--keep-global-symbol} options.
1462 Permit regular expressions in @var{symbolname}s used in other command
1463 line options. The question mark (?), asterisk (*), backslash (\) and
1464 square brackets ([]) operators can be used anywhere in the symbol
1465 name. If the first character of the symbol name is the exclamation
1466 point (!) then the sense of the switch is reversed for that symbol.
1473 would cause objcopy to weaken all symbols that start with ``fo''
1474 except for the symbol ``foo''.
1477 @itemx --discard-all
1478 Do not copy non-global symbols from the source file.
1479 @c FIXME any reason to prefer "non-global" to "local" here?
1482 @itemx --discard-locals
1483 Do not copy compiler-generated local symbols.
1484 (These usually start with @samp{L} or @samp{.}.)
1487 @itemx --byte=@var{byte}
1488 If interleaving has been enabled via the @option{--interleave} option
1489 then start the range of bytes to keep at the @var{byte}th byte.
1490 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1491 @var{breadth} is the value given by the @option{--interleave} option.
1493 @item -i [@var{breadth}]
1494 @itemx --interleave[=@var{breadth}]
1495 Only copy a range out of every @var{breadth} bytes. (Header data is
1496 not affected). Select which byte in the range begins the copy with
1497 the @option{--byte} option. Select the width of the range with the
1498 @option{--interleave-width} option.
1500 This option is useful for creating files to program @sc{rom}. It is
1501 typically used with an @code{srec} output target. Note that
1502 @command{objcopy} will complain if you do not specify the
1503 @option{--byte} option as well.
1505 The default interleave breadth is 4, so with @option{--byte} set to 0,
1506 @command{objcopy} would copy the first byte out of every four bytes
1507 from the input to the output.
1509 @item --interleave-width=@var{width}
1510 When used with the @option{--interleave} option, copy @var{width}
1511 bytes at a time. The start of the range of bytes to be copied is set
1512 by the @option{--byte} option, and the extent of the range is set with
1513 the @option{--interleave} option.
1515 The default value for this option is 1. The value of @var{width} plus
1516 the @var{byte} value set by the @option{--byte} option must not exceed
1517 the interleave breadth set by the @option{--interleave} option.
1519 This option can be used to create images for two 16-bit flashes interleaved
1520 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1521 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1522 commands. If the input was '12345678' then the outputs would be
1523 '1256' and '3478' respectively.
1526 @itemx --preserve-dates
1527 Set the access and modification dates of the output file to be the same
1528 as those of the input file.
1531 @itemx --enable-deterministic-archives
1532 @cindex deterministic archives
1533 @kindex --enable-deterministic-archives
1534 Operate in @emph{deterministic} mode. When copying archive members
1535 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1536 and use consistent file modes for all files.
1538 If @file{binutils} was configured with
1539 @option{--enable-deterministic-archives}, then this mode is on by default.
1540 It can be disabled with the @samp{-U} option, below.
1543 @itemx --disable-deterministic-archives
1544 @cindex deterministic archives
1545 @kindex --enable-deterministic-archives
1546 Do @emph{not} operate in @emph{deterministic} mode. This is the
1547 inverse of the @option{-D} option, above: when copying archive members
1548 and writing the archive index, use their actual UID, GID, timestamp,
1549 and file mode values.
1551 This is the default unless @file{binutils} was configured with
1552 @option{--enable-deterministic-archives}.
1555 Convert debugging information, if possible. This is not the default
1556 because only certain debugging formats are supported, and the
1557 conversion process can be time consuming.
1559 @item --gap-fill @var{val}
1560 Fill gaps between sections with @var{val}. This operation applies to
1561 the @emph{load address} (LMA) of the sections. It is done by increasing
1562 the size of the section with the lower address, and filling in the extra
1563 space created with @var{val}.
1565 @item --pad-to @var{address}
1566 Pad the output file up to the load address @var{address}. This is
1567 done by increasing the size of the last section. The extra space is
1568 filled in with the value specified by @option{--gap-fill} (default zero).
1570 @item --set-start @var{val}
1571 Set the start address of the new file to @var{val}. Not all object file
1572 formats support setting the start address.
1574 @item --change-start @var{incr}
1575 @itemx --adjust-start @var{incr}
1576 @cindex changing start address
1577 Change the start address by adding @var{incr}. Not all object file
1578 formats support setting the start address.
1580 @item --change-addresses @var{incr}
1581 @itemx --adjust-vma @var{incr}
1582 @cindex changing object addresses
1583 Change the VMA and LMA addresses of all sections, as well as the start
1584 address, by adding @var{incr}. Some object file formats do not permit
1585 section addresses to be changed arbitrarily. Note that this does not
1586 relocate the sections; if the program expects sections to be loaded at a
1587 certain address, and this option is used to change the sections such
1588 that they are loaded at a different address, the program may fail.
1590 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1591 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1592 @cindex changing section address
1593 Set or change both the VMA address and the LMA address of any section
1594 matching @var{sectionpattern}. If @samp{=} is used, the section
1595 address is set to @var{val}. Otherwise, @var{val} is added to or
1596 subtracted from the section address. See the comments under
1597 @option{--change-addresses}, above. If @var{sectionpattern} does not
1598 match any sections in the input file, a warning will be issued, unless
1599 @option{--no-change-warnings} is used.
1601 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1602 @cindex changing section LMA
1603 Set or change the LMA address of any sections matching
1604 @var{sectionpattern}. The LMA address is the address where the
1605 section will be loaded into memory at program load time. Normally
1606 this is the same as the VMA address, which is the address of the
1607 section at program run time, but on some systems, especially those
1608 where a program is held in ROM, the two can be different. If @samp{=}
1609 is used, the section address is set to @var{val}. Otherwise,
1610 @var{val} is added to or subtracted from the section address. See the
1611 comments under @option{--change-addresses}, above. If
1612 @var{sectionpattern} does not match any sections in the input file, a
1613 warning will be issued, unless @option{--no-change-warnings} is used.
1615 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1616 @cindex changing section VMA
1617 Set or change the VMA address of any section matching
1618 @var{sectionpattern}. The VMA address is the address where the
1619 section will be located once the program has started executing.
1620 Normally this is the same as the LMA address, which is the address
1621 where the section will be loaded into memory, but on some systems,
1622 especially those where a program is held in ROM, the two can be
1623 different. If @samp{=} is used, the section address is set to
1624 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1625 section address. See the comments under @option{--change-addresses},
1626 above. If @var{sectionpattern} does not match any sections in the
1627 input file, a warning will be issued, unless
1628 @option{--no-change-warnings} is used.
1630 @item --change-warnings
1631 @itemx --adjust-warnings
1632 If @option{--change-section-address} or @option{--change-section-lma} or
1633 @option{--change-section-vma} is used, and the section pattern does not
1634 match any sections, issue a warning. This is the default.
1636 @item --no-change-warnings
1637 @itemx --no-adjust-warnings
1638 Do not issue a warning if @option{--change-section-address} or
1639 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1640 if the section pattern does not match any sections.
1642 @item --set-section-flags @var{sectionpattern}=@var{flags}
1643 Set the flags for any sections matching @var{sectionpattern}. The
1644 @var{flags} argument is a comma separated string of flag names. The
1645 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1646 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1647 @samp{exclude}, @samp{share}, and @samp{debug}. You can set the
1648 @samp{contents} flag for a section which does not have contents, but it
1649 is not meaningful to clear the @samp{contents} flag of a section which
1650 does have contents--just remove the section instead. Not all flags are
1651 meaningful for all object file formats. In particular the
1652 @samp{share} flag is only meaningful for COFF format files and not for
1655 @item --set-section-alignment @var{sectionpattern}=@var{align}
1656 Set the alignment for any sections matching @var{sectionpattern}.
1657 @var{align} specifies the alignment in bytes and must be a power of
1658 two, i.e. 1, 2, 4, 8@dots{}.
1660 @item --add-section @var{sectionname}=@var{filename}
1661 Add a new section named @var{sectionname} while copying the file. The
1662 contents of the new section are taken from the file @var{filename}. The
1663 size of the section will be the size of the file. This option only
1664 works on file formats which can support sections with arbitrary names.
1665 Note - it may be necessary to use the @option{--set-section-flags}
1666 option to set the attributes of the newly created section.
1668 @item --dump-section @var{sectionname}=@var{filename}
1669 Place the contents of section named @var{sectionname} into the file
1670 @var{filename}, overwriting any contents that may have been there
1671 previously. This option is the inverse of @option{--add-section}.
1672 This option is similar to the @option{--only-section} option except
1673 that it does not create a formatted file, it just dumps the contents
1674 as raw binary data, without applying any relocations. The option can
1675 be specified more than once.
1677 @item --update-section @var{sectionname}=@var{filename}
1678 Replace the existing contents of a section named @var{sectionname}
1679 with the contents of file @var{filename}. The size of the section
1680 will be adjusted to the size of the file. The section flags for
1681 @var{sectionname} will be unchanged. For ELF format files the section
1682 to segment mapping will also remain unchanged, something which is not
1683 possible using @option{--remove-section} followed by
1684 @option{--add-section}. The option can be specified more than once.
1686 Note - it is possible to use @option{--rename-section} and
1687 @option{--update-section} to both update and rename a section from one
1688 command line. In this case, pass the original section name to
1689 @option{--update-section}, and the original and new section names to
1690 @option{--rename-section}.
1692 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1693 Add a new symbol named @var{name} while copying the file. This option may be
1694 specified multiple times. If the @var{section} is given, the symbol will be
1695 associated with and relative to that section, otherwise it will be an ABS
1696 symbol. Specifying an undefined section will result in a fatal error. There
1697 is no check for the value, it will be taken as specified. Symbol flags can
1698 be specified and not all flags will be meaningful for all object file
1699 formats. By default, the symbol will be global. The special flag
1700 'before=@var{othersym}' will insert the new symbol in front of the specified
1701 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1702 symbol table in the order they appear.
1704 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1705 Rename a section from @var{oldname} to @var{newname}, optionally
1706 changing the section's flags to @var{flags} in the process. This has
1707 the advantage over using a linker script to perform the rename in that
1708 the output stays as an object file and does not become a linked
1709 executable. This option accepts the same set of flags as the
1710 @option{--sect-section-flags} option.
1712 This option is particularly helpful when the input format is binary,
1713 since this will always create a section called .data. If for example,
1714 you wanted instead to create a section called .rodata containing binary
1715 data you could use the following command line to achieve it:
1718 objcopy -I binary -O <output_format> -B <architecture> \
1719 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1720 <input_binary_file> <output_object_file>
1723 @item --long-section-names @{enable,disable,keep@}
1724 Controls the handling of long section names when processing @code{COFF}
1725 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1726 is to preserve long section names if any are present in the input file.
1727 The @samp{enable} and @samp{disable} options forcibly enable or disable
1728 the use of long section names in the output object; when @samp{disable}
1729 is in effect, any long section names in the input object will be truncated.
1730 The @samp{enable} option will only emit long section names if any are
1731 present in the inputs; this is mostly the same as @samp{keep}, but it
1732 is left undefined whether the @samp{enable} option might force the
1733 creation of an empty string table in the output file.
1735 @item --change-leading-char
1736 Some object file formats use special characters at the start of
1737 symbols. The most common such character is underscore, which compilers
1738 often add before every symbol. This option tells @command{objcopy} to
1739 change the leading character of every symbol when it converts between
1740 object file formats. If the object file formats use the same leading
1741 character, this option has no effect. Otherwise, it will add a
1742 character, or remove a character, or change a character, as
1745 @item --remove-leading-char
1746 If the first character of a global symbol is a special symbol leading
1747 character used by the object file format, remove the character. The
1748 most common symbol leading character is underscore. This option will
1749 remove a leading underscore from all global symbols. This can be useful
1750 if you want to link together objects of different file formats with
1751 different conventions for symbol names. This is different from
1752 @option{--change-leading-char} because it always changes the symbol name
1753 when appropriate, regardless of the object file format of the output
1756 @item --reverse-bytes=@var{num}
1757 Reverse the bytes in a section with output contents. A section length must
1758 be evenly divisible by the value given in order for the swap to be able to
1759 take place. Reversing takes place before the interleaving is performed.
1761 This option is used typically in generating ROM images for problematic
1762 target systems. For example, on some target boards, the 32-bit words
1763 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1764 regardless of the CPU byte order. Depending on the programming model, the
1765 endianness of the ROM may need to be modified.
1767 Consider a simple file with a section containing the following eight
1768 bytes: @code{12345678}.
1770 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1771 output file would be ordered @code{21436587}.
1773 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1774 output file would be ordered @code{43218765}.
1776 By using @samp{--reverse-bytes=2} for the above example, followed by
1777 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1778 output file would be ordered @code{34127856}.
1780 @item --srec-len=@var{ival}
1781 Meaningful only for srec output. Set the maximum length of the Srecords
1782 being produced to @var{ival}. This length covers both address, data and
1785 @item --srec-forceS3
1786 Meaningful only for srec output. Avoid generation of S1/S2 records,
1787 creating S3-only record format.
1789 @item --redefine-sym @var{old}=@var{new}
1790 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1791 when one is trying link two things together for which you have no
1792 source, and there are name collisions.
1794 @item --redefine-syms=@var{filename}
1795 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1796 listed in the file @var{filename}. @var{filename} is simply a flat file,
1797 with one symbol pair per line. Line comments may be introduced by the hash
1798 character. This option may be given more than once.
1801 Change all global symbols in the file to be weak. This can be useful
1802 when building an object which will be linked against other objects using
1803 the @option{-R} option to the linker. This option is only effective when
1804 using an object file format which supports weak symbols.
1806 @item --keep-symbols=@var{filename}
1807 Apply @option{--keep-symbol} option to each symbol listed in the file
1808 @var{filename}. @var{filename} is simply a flat file, with one symbol
1809 name per line. Line comments may be introduced by the hash character.
1810 This option may be given more than once.
1812 @item --strip-symbols=@var{filename}
1813 Apply @option{--strip-symbol} option to each symbol listed in the file
1814 @var{filename}. @var{filename} is simply a flat file, with one symbol
1815 name per line. Line comments may be introduced by the hash character.
1816 This option may be given more than once.
1818 @item --strip-unneeded-symbols=@var{filename}
1819 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1820 the file @var{filename}. @var{filename} is simply a flat file, with one
1821 symbol name per line. Line comments may be introduced by the hash
1822 character. This option may be given more than once.
1824 @item --keep-global-symbols=@var{filename}
1825 Apply @option{--keep-global-symbol} option to each symbol listed in the
1826 file @var{filename}. @var{filename} is simply a flat file, with one
1827 symbol name per line. Line comments may be introduced by the hash
1828 character. This option may be given more than once.
1830 @item --localize-symbols=@var{filename}
1831 Apply @option{--localize-symbol} option to each symbol listed in the file
1832 @var{filename}. @var{filename} is simply a flat file, with one symbol
1833 name per line. Line comments may be introduced by the hash character.
1834 This option may be given more than once.
1836 @item --globalize-symbols=@var{filename}
1837 Apply @option{--globalize-symbol} option to each symbol listed in the file
1838 @var{filename}. @var{filename} is simply a flat file, with one symbol
1839 name per line. Line comments may be introduced by the hash character.
1840 This option may be given more than once. Note: this option cannot be
1841 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1844 @item --weaken-symbols=@var{filename}
1845 Apply @option{--weaken-symbol} option to each symbol listed in the file
1846 @var{filename}. @var{filename} is simply a flat file, with one symbol
1847 name per line. Line comments may be introduced by the hash character.
1848 This option may be given more than once.
1850 @item --alt-machine-code=@var{index}
1851 If the output architecture has alternate machine codes, use the
1852 @var{index}th code instead of the default one. This is useful in case
1853 a machine is assigned an official code and the tool-chain adopts the
1854 new code, but other applications still depend on the original code
1855 being used. For ELF based architectures if the @var{index}
1856 alternative does not exist then the value is treated as an absolute
1857 number to be stored in the e_machine field of the ELF header.
1859 @item --writable-text
1860 Mark the output text as writable. This option isn't meaningful for all
1861 object file formats.
1863 @item --readonly-text
1864 Make the output text write protected. This option isn't meaningful for all
1865 object file formats.
1868 Mark the output file as demand paged. This option isn't meaningful for all
1869 object file formats.
1872 Mark the output file as impure. This option isn't meaningful for all
1873 object file formats.
1875 @item --prefix-symbols=@var{string}
1876 Prefix all symbols in the output file with @var{string}.
1878 @item --prefix-sections=@var{string}
1879 Prefix all section names in the output file with @var{string}.
1881 @item --prefix-alloc-sections=@var{string}
1882 Prefix all the names of all allocated sections in the output file with
1885 @item --add-gnu-debuglink=@var{path-to-file}
1886 Creates a .gnu_debuglink section which contains a reference to
1887 @var{path-to-file} and adds it to the output file. Note: the file at
1888 @var{path-to-file} must exist. Part of the process of adding the
1889 .gnu_debuglink section involves embedding a checksum of the contents
1890 of the debug info file into the section.
1892 If the debug info file is built in one location but it is going to be
1893 installed at a later time into a different location then do not use
1894 the path to the installed location. The @option{--add-gnu-debuglink}
1895 option will fail because the installed file does not exist yet.
1896 Instead put the debug info file in the current directory and use the
1897 @option{--add-gnu-debuglink} option without any directory components,
1901 objcopy --add-gnu-debuglink=foo.debug
1904 At debug time the debugger will attempt to look for the separate debug
1905 info file in a set of known locations. The exact set of these
1906 locations varies depending upon the distribution being used, but it
1911 @item * The same directory as the executable.
1913 @item * A sub-directory of the directory containing the executable
1916 @item * A global debug directory such as /usr/lib/debug.
1919 As long as the debug info file has been installed into one of these
1920 locations before the debugger is run everything should work
1923 @item --keep-file-symbols
1924 When stripping a file, perhaps with @option{--strip-debug} or
1925 @option{--strip-unneeded}, retain any symbols specifying source file names,
1926 which would otherwise get stripped.
1928 @item --only-keep-debug
1929 Strip a file, removing contents of any sections that would not be
1930 stripped by @option{--strip-debug} and leaving the debugging sections
1931 intact. In ELF files, this preserves all note sections in the output.
1933 Note - the section headers of the stripped sections are preserved,
1934 including their sizes, but the contents of the section are discarded.
1935 The section headers are preserved so that other tools can match up the
1936 debuginfo file with the real executable, even if that executable has
1937 been relocated to a different address space.
1939 The intention is that this option will be used in conjunction with
1940 @option{--add-gnu-debuglink} to create a two part executable. One a
1941 stripped binary which will occupy less space in RAM and in a
1942 distribution and the second a debugging information file which is only
1943 needed if debugging abilities are required. The suggested procedure
1944 to create these files is as follows:
1947 @item Link the executable as normal. Assuming that it is called
1949 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1950 create a file containing the debugging info.
1951 @item Run @code{objcopy --strip-debug foo} to create a
1952 stripped executable.
1953 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1954 to add a link to the debugging info into the stripped executable.
1957 Note---the choice of @code{.dbg} as an extension for the debug info
1958 file is arbitrary. Also the @code{--only-keep-debug} step is
1959 optional. You could instead do this:
1962 @item Link the executable as normal.
1963 @item Copy @code{foo} to @code{foo.full}
1964 @item Run @code{objcopy --strip-debug foo}
1965 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1968 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1969 full executable. It does not have to be a file created by the
1970 @option{--only-keep-debug} switch.
1972 Note---this switch is only intended for use on fully linked files. It
1973 does not make sense to use it on object files where the debugging
1974 information may be incomplete. Besides the gnu_debuglink feature
1975 currently only supports the presence of one filename containing
1976 debugging information, not multiple filenames on a one-per-object-file
1980 Remove the contents of all DWARF .dwo sections, leaving the
1981 remaining debugging sections and all symbols intact.
1982 This option is intended for use by the compiler as part of
1983 the @option{-gsplit-dwarf} option, which splits debug information
1984 between the .o file and a separate .dwo file. The compiler
1985 generates all debug information in the same file, then uses
1986 the @option{--extract-dwo} option to copy the .dwo sections to
1987 the .dwo file, then the @option{--strip-dwo} option to remove
1988 those sections from the original .o file.
1991 Extract the contents of all DWARF .dwo sections. See the
1992 @option{--strip-dwo} option for more information.
1994 @item --file-alignment @var{num}
1995 Specify the file alignment. Sections in the file will always begin at
1996 file offsets which are multiples of this number. This defaults to
1998 [This option is specific to PE targets.]
2000 @item --heap @var{reserve}
2001 @itemx --heap @var{reserve},@var{commit}
2002 Specify the number of bytes of memory to reserve (and optionally commit)
2003 to be used as heap for this program.
2004 [This option is specific to PE targets.]
2006 @item --image-base @var{value}
2007 Use @var{value} as the base address of your program or dll. This is
2008 the lowest memory location that will be used when your program or dll
2009 is loaded. To reduce the need to relocate and improve performance of
2010 your dlls, each should have a unique base address and not overlap any
2011 other dlls. The default is 0x400000 for executables, and 0x10000000
2013 [This option is specific to PE targets.]
2015 @item --section-alignment @var{num}
2016 Sets the section alignment field in the PE header. Sections in memory
2017 will always begin at addresses which are a multiple of this number.
2019 [This option is specific to PE targets.]
2021 @item --stack @var{reserve}
2022 @itemx --stack @var{reserve},@var{commit}
2023 Specify the number of bytes of memory to reserve (and optionally commit)
2024 to be used as stack for this program.
2025 [This option is specific to PE targets.]
2027 @item --subsystem @var{which}
2028 @itemx --subsystem @var{which}:@var{major}
2029 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2030 Specifies the subsystem under which your program will execute. The
2031 legal values for @var{which} are @code{native}, @code{windows},
2032 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
2033 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
2034 the subsystem version also. Numeric values are also accepted for
2036 [This option is specific to PE targets.]
2038 @item --extract-symbol
2039 Keep the file's section flags and symbols but remove all section data.
2040 Specifically, the option:
2043 @item removes the contents of all sections;
2044 @item sets the size of every section to zero; and
2045 @item sets the file's start address to zero.
2048 This option is used to build a @file{.sym} file for a VxWorks kernel.
2049 It can also be a useful way of reducing the size of a @option{--just-symbols}
2052 @item --compress-debug-sections
2053 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2054 ELF ABI. Note - if compression would actually make a section
2055 @emph{larger}, then it is not compressed.
2057 @item --compress-debug-sections=none
2058 @itemx --compress-debug-sections=zlib
2059 @itemx --compress-debug-sections=zlib-gnu
2060 @itemx --compress-debug-sections=zlib-gabi
2061 For ELF files, these options control how DWARF debug sections are
2062 compressed. @option{--compress-debug-sections=none} is equivalent
2063 to @option{--decompress-debug-sections}.
2064 @option{--compress-debug-sections=zlib} and
2065 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2066 @option{--compress-debug-sections}.
2067 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
2068 sections using zlib. The debug sections are renamed to begin with
2069 @samp{.zdebug} instead of @samp{.debug}. Note - if compression would
2070 actually make a section @emph{larger}, then it is not compressed nor
2073 @item --decompress-debug-sections
2074 Decompress DWARF debug sections using zlib. The original section
2075 names of the compressed sections are restored.
2077 @item --elf-stt-common=yes
2078 @itemx --elf-stt-common=no
2079 For ELF files, these options control whether common symbols should be
2080 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2081 @option{--elf-stt-common=yes} converts common symbol type to
2082 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2083 type to @code{STT_OBJECT}.
2086 @itemx --no-merge-notes
2087 For ELF files, attempt (or do not attempt) to reduce the size of any
2088 SHT_NOTE type sections by removing duplicate notes.
2092 Show the version number of @command{objcopy}.
2094 @item --verilog-data-width=@var{bytes}
2095 For Verilog output, this options controls the number of bytes
2096 converted for each output data element. The input target controls the
2097 endianness of the conversion.
2101 Verbose output: list all object files modified. In the case of
2102 archives, @samp{objcopy -V} lists all members of the archive.
2105 Show a summary of the options to @command{objcopy}.
2108 Display a list showing all architectures and object formats available.
2114 @c man begin SEEALSO objcopy
2115 ld(1), objdump(1), and the Info entries for @file{binutils}.
2122 @cindex object file information
2125 @c man title objdump display information from object files
2128 @c man begin SYNOPSIS objdump
2129 objdump [@option{-a}|@option{--archive-headers}]
2130 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2131 [@option{-C}|@option{--demangle}[=@var{style}] ]
2132 [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2133 [@option{-D}|@option{--disassemble-all}]
2134 [@option{-z}|@option{--disassemble-zeroes}]
2135 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2136 [@option{-f}|@option{--file-headers}]
2137 [@option{-F}|@option{--file-offsets}]
2138 [@option{--file-start-context}]
2139 [@option{-g}|@option{--debugging}]
2140 [@option{-e}|@option{--debugging-tags}]
2141 [@option{-h}|@option{--section-headers}|@option{--headers}]
2142 [@option{-i}|@option{--info}]
2143 [@option{-j} @var{section}|@option{--section=}@var{section}]
2144 [@option{-l}|@option{--line-numbers}]
2145 [@option{-S}|@option{--source}]
2146 [@option{--source-comment}[=@var{text}]]
2147 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2148 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2149 [@option{-p}|@option{--private-headers}]
2150 [@option{-P} @var{options}|@option{--private=}@var{options}]
2151 [@option{-r}|@option{--reloc}]
2152 [@option{-R}|@option{--dynamic-reloc}]
2153 [@option{-s}|@option{--full-contents}]
2154 [@option{-W[lLiaprmfFsoRtUuTgAckK]}|
2155 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
2156 [@option{--ctf=}@var{section}]
2157 [@option{-G}|@option{--stabs}]
2158 [@option{-t}|@option{--syms}]
2159 [@option{-T}|@option{--dynamic-syms}]
2160 [@option{-x}|@option{--all-headers}]
2161 [@option{-w}|@option{--wide}]
2162 [@option{--start-address=}@var{address}]
2163 [@option{--stop-address=}@var{address}]
2164 [@option{--no-addresses}]
2165 [@option{--prefix-addresses}]
2166 [@option{--[no-]show-raw-insn}]
2167 [@option{--adjust-vma=}@var{offset}]
2168 [@option{--dwarf-depth=@var{n}}]
2169 [@option{--dwarf-start=@var{n}}]
2170 [@option{--ctf-parent=}@var{section}]
2171 [@option{--no-recurse-limit}|@option{--recurse-limit}]
2172 [@option{--special-syms}]
2173 [@option{--prefix=}@var{prefix}]
2174 [@option{--prefix-strip=}@var{level}]
2175 [@option{--insn-width=}@var{width}]
2176 [@option{--visualize-jumps[=color|=extended-color|=off]}
2177 [@option{-V}|@option{--version}]
2178 [@option{-H}|@option{--help}]
2179 @var{objfile}@dots{}
2183 @c man begin DESCRIPTION objdump
2185 @command{objdump} displays information about one or more object files.
2186 The options control what particular information to display. This
2187 information is mostly useful to programmers who are working on the
2188 compilation tools, as opposed to programmers who just want their
2189 program to compile and work.
2191 @var{objfile}@dots{} are the object files to be examined. When you
2192 specify archives, @command{objdump} shows information on each of the member
2197 @c man begin OPTIONS objdump
2199 The long and short forms of options, shown here as alternatives, are
2200 equivalent. At least one option from the list
2201 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2205 @itemx --archive-header
2206 @cindex archive headers
2207 If any of the @var{objfile} files are archives, display the archive
2208 header information (in a format similar to @samp{ls -l}). Besides the
2209 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2210 the object file format of each archive member.
2212 @item --adjust-vma=@var{offset}
2213 @cindex section addresses in objdump
2214 @cindex VMA in objdump
2215 When dumping information, first add @var{offset} to all the section
2216 addresses. This is useful if the section addresses do not correspond to
2217 the symbol table, which can happen when putting sections at particular
2218 addresses when using a format which can not represent section addresses,
2221 @item -b @var{bfdname}
2222 @itemx --target=@var{bfdname}
2223 @cindex object code format
2224 Specify that the object-code format for the object files is
2225 @var{bfdname}. This option may not be necessary; @var{objdump} can
2226 automatically recognize many formats.
2230 objdump -b oasys -m vax -h fu.o
2233 displays summary information from the section headers (@option{-h}) of
2234 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2235 file in the format produced by Oasys compilers. You can list the
2236 formats available with the @option{-i} option.
2237 @xref{Target Selection}, for more information.
2240 @itemx --demangle[=@var{style}]
2241 @cindex demangling in objdump
2242 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2243 Besides removing any initial underscore prepended by the system, this
2244 makes C++ function names readable. Different compilers have different
2245 mangling styles. The optional demangling style argument can be used to
2246 choose an appropriate demangling style for your compiler. @xref{c++filt},
2247 for more information on demangling.
2249 @item --recurse-limit
2250 @itemx --no-recurse-limit
2251 @itemx --recursion-limit
2252 @itemx --no-recursion-limit
2253 Enables or disables a limit on the amount of recursion performed
2254 whilst demangling strings. Since the name mangling formats allow for
2255 an inifinite level of recursion it is possible to create strings whose
2256 decoding will exhaust the amount of stack space available on the host
2257 machine, triggering a memory fault. The limit tries to prevent this
2258 from happening by restricting recursion to 2048 levels of nesting.
2260 The default is for this limit to be enabled, but disabling it may be
2261 necessary in order to demangle truly complicated names. Note however
2262 that if the recursion limit is disabled then stack exhaustion is
2263 possible and any bug reports about such an event will be rejected.
2267 Display debugging information. This attempts to parse STABS
2268 debugging format information stored in the file and print it out using
2269 a C like syntax. If no STABS debugging was found this option
2270 falls back on the @option{-W} option to print any DWARF information in
2274 @itemx --debugging-tags
2275 Like @option{-g}, but the information is generated in a format compatible
2279 @itemx --disassemble
2280 @itemx --disassemble=@var{symbol}
2281 @cindex disassembling object code
2282 @cindex machine instructions
2283 Display the assembler mnemonics for the machine instructions from the
2284 input file. This option only disassembles those sections which are
2285 expected to contain instructions. If the optional @var{symbol}
2286 argument is given, then display the assembler mnemonics starting at
2287 @var{symbol}. If @var{symbol} is a function name then disassembly
2288 will stop at the end of the function, otherwise it will stop when the
2289 next symbol is encountered. If there are no matches for @var{symbol}
2290 then nothing will be displayed.
2292 Note if the @option{--dwarf=follow-links} option has also been enabled
2293 then any symbol tables in linked debug info files will be read in and
2294 used when disassembling.
2297 @itemx --disassemble-all
2298 Like @option{-d}, but disassemble the contents of all sections, not just
2299 those expected to contain instructions.
2301 This option also has a subtle effect on the disassembly of
2302 instructions in code sections. When option @option{-d} is in effect
2303 objdump will assume that any symbols present in a code section occur
2304 on the boundary between instructions and it will refuse to disassemble
2305 across such a boundary. When option @option{-D} is in effect however
2306 this assumption is supressed. This means that it is possible for the
2307 output of @option{-d} and @option{-D} to differ if, for example, data
2308 is stored in code sections.
2310 If the target is an ARM architecture this switch also has the effect
2311 of forcing the disassembler to decode pieces of data found in code
2312 sections as if they were instructions.
2314 Note if the @option{--dwarf=follow-links} option has also been enabled
2315 then any symbol tables in linked debug info files will be read in and
2316 used when disassembling.
2318 @item --no-addresses
2319 When disassembling, don't print addresses on each line or for symbols
2320 and relocation offsets.
2322 @item --prefix-addresses
2323 When disassembling, print the complete address on each line. This is
2324 the older disassembly format.
2328 @itemx --endian=@{big|little@}
2330 @cindex disassembly endianness
2331 Specify the endianness of the object files. This only affects
2332 disassembly. This can be useful when disassembling a file format which
2333 does not describe endianness information, such as S-records.
2336 @itemx --file-headers
2337 @cindex object file header
2338 Display summary information from the overall header of
2339 each of the @var{objfile} files.
2342 @itemx --file-offsets
2343 @cindex object file offsets
2344 When disassembling sections, whenever a symbol is displayed, also
2345 display the file offset of the region of data that is about to be
2346 dumped. If zeroes are being skipped, then when disassembly resumes,
2347 tell the user how many zeroes were skipped and the file offset of the
2348 location from where the disassembly resumes. When dumping sections,
2349 display the file offset of the location from where the dump starts.
2351 @item --file-start-context
2352 @cindex source code context
2353 Specify that when displaying interlisted source code/disassembly
2354 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2355 context to the start of the file.
2358 @itemx --section-headers
2360 @cindex section headers
2361 Display summary information from the section headers of the
2364 File segments may be relocated to nonstandard addresses, for example by
2365 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2366 @command{ld}. However, some object file formats, such as a.out, do not
2367 store the starting address of the file segments. In those situations,
2368 although @command{ld} relocates the sections correctly, using @samp{objdump
2369 -h} to list the file section headers cannot show the correct addresses.
2370 Instead, it shows the usual addresses, which are implicit for the
2373 Note, in some cases it is possible for a section to have both the
2374 READONLY and the NOREAD attributes set. In such cases the NOREAD
2375 attribute takes precedence, but @command{objdump} will report both
2376 since the exact setting of the flag bits might be important.
2380 Print a summary of the options to @command{objdump} and exit.
2384 @cindex architectures available
2385 @cindex object formats available
2386 Display a list showing all architectures and object formats available
2387 for specification with @option{-b} or @option{-m}.
2390 @itemx --section=@var{name}
2391 @cindex section information
2392 Display information only for section @var{name}.
2395 @itemx --line-numbers
2396 @cindex source filenames for object files
2397 Label the display (using debugging information) with the filename and
2398 source line numbers corresponding to the object code or relocs shown.
2399 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2401 @item -m @var{machine}
2402 @itemx --architecture=@var{machine}
2403 @cindex architecture
2404 @cindex disassembly architecture
2405 Specify the architecture to use when disassembling object files. This
2406 can be useful when disassembling object files which do not describe
2407 architecture information, such as S-records. You can list the available
2408 architectures with the @option{-i} option.
2410 If the target is an ARM architecture then this switch has an
2411 additional effect. It restricts the disassembly to only those
2412 instructions supported by the architecture specified by @var{machine}.
2413 If it is necessary to use this switch because the input file does not
2414 contain any architecture information, but it is also desired to
2415 disassemble all the instructions use @option{-marm}.
2417 @item -M @var{options}
2418 @itemx --disassembler-options=@var{options}
2419 Pass target specific information to the disassembler. Only supported on
2420 some targets. If it is necessary to specify more than one
2421 disassembler option then multiple @option{-M} options can be used or
2422 can be placed together into a comma separated list.
2424 For ARC, @option{dsp} controls the printing of DSP instructions,
2425 @option{spfp} selects the printing of FPX single precision FP
2426 instructions, @option{dpfp} selects the printing of FPX double
2427 precision FP instructions, @option{quarkse_em} selects the printing of
2428 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2429 of double precision assist instructions, @option{fpus} selects the
2430 printing of FPU single precision FP instructions, while @option{fpud}
2431 selects the printing of FPU double precision FP instructions.
2432 Additionally, one can choose to have all the immediates printed in
2433 hexadecimal using @option{hex}. By default, the short immediates are
2434 printed using the decimal representation, while the long immediate
2435 values are printed as hexadecimal.
2437 @option{cpu=...} allows to enforce a particular ISA when disassembling
2438 instructions, overriding the @option{-m} value or whatever is in the ELF file.
2439 This might be useful to select ARC EM or HS ISA, because architecture is same
2440 for those and disassembler relies on private ELF header data to decide if code
2441 is for EM or HS. This option might be specified multiple times - only the
2442 latest value will be used. Valid values are same as for the assembler
2443 @option{-mcpu=...} option.
2445 If the target is an ARM architecture then this switch can be used to
2446 select which register name set is used during disassembler. Specifying
2447 @option{-M reg-names-std} (the default) will select the register names as
2448 used in ARM's instruction set documentation, but with register 13 called
2449 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2450 @option{-M reg-names-apcs} will select the name set used by the ARM
2451 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2452 just use @samp{r} followed by the register number.
2454 There are also two variants on the APCS register naming scheme enabled
2455 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2456 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2457 with the normal register names or the special register names).
2459 This option can also be used for ARM architectures to force the
2460 disassembler to interpret all instructions as Thumb instructions by
2461 using the switch @option{--disassembler-options=force-thumb}. This can be
2462 useful when attempting to disassemble thumb code produced by other
2465 For AArch64 targets this switch can be used to set whether instructions are
2466 disassembled as the most general instruction using the @option{-M no-aliases}
2467 option or whether instruction notes should be generated as comments in the
2468 disasssembly using @option{-M notes}.
2470 For the x86, some of the options duplicate functions of the @option{-m}
2471 switch, but allow finer grained control. Multiple selections from the
2472 following may be specified as a comma separated string.
2477 Select disassembly for the given architecture.
2481 Select between intel syntax mode and AT&T syntax mode.
2485 Select between AMD64 ISA and Intel64 ISA.
2487 @item intel-mnemonic
2489 Select between intel mnemonic mode and AT&T mnemonic mode.
2490 Note: @code{intel-mnemonic} implies @code{intel} and
2491 @code{att-mnemonic} implies @code{att}.
2498 Specify the default address size and operand size. These five options
2499 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2500 appear later in the option string.
2503 When in AT&T mode, instructs the disassembler to print a mnemonic
2504 suffix even when the suffix could be inferred by the operands.
2507 For PowerPC, the @option{-M} argument @option{raw} selects
2508 disasssembly of hardware insns rather than aliases. For example, you
2509 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2510 rather than @code{li}. All of the @option{-m} arguments for
2511 @command{gas} that select a CPU are supported. These are:
2512 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2513 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2514 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2515 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2516 @option{booke32}, @option{cell}, @option{com}, @option{e200z4},
2517 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2518 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2519 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2520 @option{power8}, @option{power9}, @option{ppc}, @option{ppc32},
2521 @option{ppc64}, @option{ppc64bridge}, @option{ppcps}, @option{pwr},
2522 @option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2523 @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9},
2524 @option{pwrx}, @option{titan}, and @option{vle}.
2525 @option{32} and @option{64} modify the default or a prior CPU
2526 selection, disabling and enabling 64-bit insns respectively. In
2527 addition, @option{altivec}, @option{any}, @option{htm}, @option{vsx},
2528 and @option{spe} add capabilities to a previous @emph{or later} CPU
2529 selection. @option{any} will disassemble any opcode known to
2530 binutils, but in cases where an opcode has two different meanings or
2531 different arguments, you may not see the disassembly you expect.
2532 If you disassemble without giving a CPU selection, a default will be
2533 chosen from information gleaned by BFD from the object files headers,
2534 but the result again may not be as you expect.
2536 For MIPS, this option controls the printing of instruction mnemonic
2537 names and register names in disassembled instructions. Multiple
2538 selections from the following may be specified as a comma separated
2539 string, and invalid options are ignored:
2543 Print the 'raw' instruction mnemonic instead of some pseudo
2544 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2545 'sll' instead of 'nop', etc.
2548 Disassemble MSA instructions.
2551 Disassemble the virtualization ASE instructions.
2554 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2556 @item gpr-names=@var{ABI}
2557 Print GPR (general-purpose register) names as appropriate
2558 for the specified ABI. By default, GPR names are selected according to
2559 the ABI of the binary being disassembled.
2561 @item fpr-names=@var{ABI}
2562 Print FPR (floating-point register) names as
2563 appropriate for the specified ABI. By default, FPR numbers are printed
2566 @item cp0-names=@var{ARCH}
2567 Print CP0 (system control coprocessor; coprocessor 0) register names
2568 as appropriate for the CPU or architecture specified by
2569 @var{ARCH}. By default, CP0 register names are selected according to
2570 the architecture and CPU of the binary being disassembled.
2572 @item hwr-names=@var{ARCH}
2573 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2574 as appropriate for the CPU or architecture specified by
2575 @var{ARCH}. By default, HWR names are selected according to
2576 the architecture and CPU of the binary being disassembled.
2578 @item reg-names=@var{ABI}
2579 Print GPR and FPR names as appropriate for the selected ABI.
2581 @item reg-names=@var{ARCH}
2582 Print CPU-specific register names (CP0 register and HWR names)
2583 as appropriate for the selected CPU or architecture.
2586 For any of the options listed above, @var{ABI} or
2587 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2588 rather than names, for the selected types of registers.
2589 You can list the available values of @var{ABI} and @var{ARCH} using
2590 the @option{--help} option.
2592 For VAX, you can specify function entry addresses with @option{-M
2593 entry:0xf00ba}. You can use this multiple times to properly
2594 disassemble VAX binary files that don't contain symbol tables (like
2595 ROM dumps). In these cases, the function entry mask would otherwise
2596 be decoded as VAX instructions, which would probably lead the rest
2597 of the function being wrongly disassembled.
2600 @itemx --private-headers
2601 Print information that is specific to the object file format. The exact
2602 information printed depends upon the object file format. For some
2603 object file formats, no additional information is printed.
2605 @item -P @var{options}
2606 @itemx --private=@var{options}
2607 Print information that is specific to the object file format. The
2608 argument @var{options} is a comma separated list that depends on the
2609 format (the lists of options is displayed with the help).
2611 For XCOFF, the available options are:
2627 Not all object formats support this option. In particular the ELF
2628 format does not use it.
2632 @cindex relocation entries, in object file
2633 Print the relocation entries of the file. If used with @option{-d} or
2634 @option{-D}, the relocations are printed interspersed with the
2638 @itemx --dynamic-reloc
2639 @cindex dynamic relocation entries, in object file
2640 Print the dynamic relocation entries of the file. This is only
2641 meaningful for dynamic objects, such as certain types of shared
2642 libraries. As for @option{-r}, if used with @option{-d} or
2643 @option{-D}, the relocations are printed interspersed with the
2647 @itemx --full-contents
2648 @cindex sections, full contents
2649 @cindex object file sections
2650 Display the full contents of any sections requested. By default all
2651 non-empty sections are displayed.
2655 @cindex source disassembly
2656 @cindex disassembly, with source
2657 Display source code intermixed with disassembly, if possible. Implies
2660 @item --source-comment[=@var{txt}]
2661 @cindex source disassembly
2662 @cindex disassembly, with source
2663 Like the @option{-S} option, but all source code lines are displayed
2664 with a prefix of @var{txt}. Typically @var{txt} will be a comment
2665 string which can be used to distinguish the assembler code from the
2666 source code. If @var{txt} is not provided then a default string of
2667 @var{``# ``} (hash followed by a space), will be used.
2669 @item --prefix=@var{prefix}
2670 @cindex Add prefix to absolute paths
2671 Specify @var{prefix} to add to the absolute paths when used with
2674 @item --prefix-strip=@var{level}
2675 @cindex Strip absolute paths
2676 Indicate how many initial directory names to strip off the hardwired
2677 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2679 @item --show-raw-insn
2680 When disassembling instructions, print the instruction in hex as well as
2681 in symbolic form. This is the default except when
2682 @option{--prefix-addresses} is used.
2684 @item --no-show-raw-insn
2685 When disassembling instructions, do not print the instruction bytes.
2686 This is the default when @option{--prefix-addresses} is used.
2688 @item --insn-width=@var{width}
2689 @cindex Instruction width
2690 Display @var{width} bytes on a single line when disassembling
2693 @item --visualize-jumps[=color|=extended-color|=off]
2694 Visualize jumps that stay inside a function by drawing ASCII art between
2695 the start and target addresses. The optional @option{=color} argument
2696 adds color to the output using simple terminal colors. Alternatively
2697 the @option{=extended-color} argument will add color using 8bit
2698 colors, but these might not work on all terminals.
2700 If it is necessary to disable the @option{visualize-jumps} option
2701 after it has previously been enabled then use
2702 @option{visualize-jumps=off}.
2704 @item -W[lLiaprmfFsoRtUuTgAckK]
2705 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2706 @include debug.options.texi
2709 Enable additional checks for consistency of Dwarf information.
2711 @include ctf.options.texi
2717 @cindex debug symbols
2718 @cindex ELF object file format
2719 Display the full contents of any sections requested. Display the
2720 contents of the .stab and .stab.index and .stab.excl sections from an
2721 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2722 @code{.stab} debugging symbol-table entries are carried in an ELF
2723 section. In most other file formats, debugging symbol-table entries are
2724 interleaved with linkage symbols, and are visible in the @option{--syms}
2727 @item --start-address=@var{address}
2728 @cindex start-address
2729 Start displaying data at the specified address. This affects the output
2730 of the @option{-d}, @option{-r} and @option{-s} options.
2732 @item --stop-address=@var{address}
2733 @cindex stop-address
2734 Stop displaying data at the specified address. This affects the output
2735 of the @option{-d}, @option{-r} and @option{-s} options.
2739 @cindex symbol table entries, printing
2740 Print the symbol table entries of the file.
2741 This is similar to the information provided by the @samp{nm} program,
2742 although the display format is different. The format of the output
2743 depends upon the format of the file being dumped, but there are two main
2744 types. One looks like this:
2747 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2748 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2751 where the number inside the square brackets is the number of the entry
2752 in the symbol table, the @var{sec} number is the section number, the
2753 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2754 symbol's type, the @var{scl} number is the symbol's storage class and
2755 the @var{nx} value is the number of auxilary entries associated with
2756 the symbol. The last two fields are the symbol's value and its name.
2758 The other common output format, usually seen with ELF based files,
2762 00000000 l d .bss 00000000 .bss
2763 00000000 g .text 00000000 fred
2766 Here the first number is the symbol's value (sometimes refered to as
2767 its address). The next field is actually a set of characters and
2768 spaces indicating the flag bits that are set on the symbol. These
2769 characters are described below. Next is the section with which the
2770 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2771 not connected with any section), or @emph{*UND*} if the section is
2772 referenced in the file being dumped, but not defined there.
2774 After the section name comes another field, a number, which for common
2775 symbols is the alignment and for other symbol is the size. Finally
2776 the symbol's name is displayed.
2778 The flag characters are divided into 7 groups as follows:
2784 The symbol is a local (l), global (g), unique global (u), neither
2785 global nor local (a space) or both global and local (!). A
2786 symbol can be neither local or global for a variety of reasons, e.g.,
2787 because it is used for debugging, but it is probably an indication of
2788 a bug if it is ever both local and global. Unique global symbols are
2789 a GNU extension to the standard set of ELF symbol bindings. For such
2790 a symbol the dynamic linker will make sure that in the entire process
2791 there is just one symbol with this name and type in use.
2794 The symbol is weak (w) or strong (a space).
2797 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2800 The symbol is a warning (W) or a normal symbol (a space). A warning
2801 symbol's name is a message to be displayed if the symbol following the
2802 warning symbol is ever referenced.
2806 The symbol is an indirect reference to another symbol (I), a function
2807 to be evaluated during reloc processing (i) or a normal symbol (a
2812 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2813 normal symbol (a space).
2818 The symbol is the name of a function (F) or a file (f) or an object
2819 (O) or just a normal symbol (a space).
2823 @itemx --dynamic-syms
2824 @cindex dynamic symbol table entries, printing
2825 Print the dynamic symbol table entries of the file. This is only
2826 meaningful for dynamic objects, such as certain types of shared
2827 libraries. This is similar to the information provided by the @samp{nm}
2828 program when given the @option{-D} (@option{--dynamic}) option.
2830 The output format is similar to that produced by the @option{--syms}
2831 option, except that an extra field is inserted before the symbol's
2832 name, giving the version information associated with the symbol.
2833 If the version is the default version to be used when resolving
2834 unversioned references to the symbol then it's displayed as is,
2835 otherwise it's put into parentheses.
2837 @item --special-syms
2838 When displaying symbols include those which the target considers to be
2839 special in some way and which would not normally be of interest to the
2844 Print the version number of @command{objdump} and exit.
2847 @itemx --all-headers
2848 @cindex all header information, object file
2849 @cindex header information, all
2850 Display all available header information, including the symbol table and
2851 relocation entries. Using @option{-x} is equivalent to specifying all of
2852 @option{-a -f -h -p -r -t}.
2856 @cindex wide output, printing
2857 Format some lines for output devices that have more than 80 columns.
2858 Also do not truncate symbol names when they are displayed.
2861 @itemx --disassemble-zeroes
2862 Normally the disassembly output will skip blocks of zeroes. This
2863 option directs the disassembler to disassemble those blocks, just like
2870 @c man begin SEEALSO objdump
2871 nm(1), readelf(1), and the Info entries for @file{binutils}.
2879 @cindex archive contents
2880 @cindex symbol index
2882 @c man title ranlib generate an index to an archive
2885 @c man begin SYNOPSIS ranlib
2886 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2890 @c man begin DESCRIPTION ranlib
2892 @command{ranlib} generates an index to the contents of an archive and
2893 stores it in the archive. The index lists each symbol defined by a
2894 member of an archive that is a relocatable object file.
2896 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2898 An archive with such an index speeds up linking to the library and
2899 allows routines in the library to call each other without regard to
2900 their placement in the archive.
2902 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2903 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2908 @c man begin OPTIONS ranlib
2914 Show usage information for @command{ranlib}.
2919 Show the version number of @command{ranlib}.
2922 @cindex deterministic archives
2923 @kindex --enable-deterministic-archives
2924 Operate in @emph{deterministic} mode. The symbol map archive member's
2925 header will show zero for the UID, GID, and timestamp. When this
2926 option is used, multiple runs will produce identical output files.
2928 If @file{binutils} was configured with
2929 @option{--enable-deterministic-archives}, then this mode is on by
2930 default. It can be disabled with the @samp{-U} option, described
2934 Update the timestamp of the symbol map of an archive.
2937 @cindex deterministic archives
2938 @kindex --enable-deterministic-archives
2939 Do @emph{not} operate in @emph{deterministic} mode. This is the
2940 inverse of the @samp{-D} option, above: the archive index will get
2941 actual UID, GID, timestamp, and file mode values.
2943 If @file{binutils} was configured @emph{without}
2944 @option{--enable-deterministic-archives}, then this mode is on by
2952 @c man begin SEEALSO ranlib
2953 ar(1), nm(1), and the Info entries for @file{binutils}.
2961 @cindex section sizes
2963 @c man title size list section sizes and total size of binary files
2966 @c man begin SYNOPSIS size
2967 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
2969 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2971 [@option{-t}|@option{--totals}]
2972 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2973 [@var{objfile}@dots{}]
2977 @c man begin DESCRIPTION size
2979 The @sc{gnu} @command{size} utility lists the section sizes and the total
2980 size for each of the binary files @var{objfile} on its argument list.
2981 By default, one line of output is generated for each file or each
2982 module if the file is an archive.
2984 @var{objfile}@dots{} are the files to be examined. If none are
2985 specified, the file @code{a.out} will be used instead.
2989 @c man begin OPTIONS size
2991 The command-line options have the following meanings:
2997 @itemx --format=@var{compatibility}
2998 @cindex @command{size} display format
2999 Using one of these options, you can choose whether the output from @sc{gnu}
3000 @command{size} resembles output from System V @command{size} (using @option{-A},
3001 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
3002 @option{--format=berkeley}). The default is the one-line format similar to
3003 Berkeley's. Alternatively, you can choose the GNU format output
3004 (using @option{-G}, or @option{--format=gnu}), this is similar to
3005 Berkeley's output format, but sizes are counted differently.
3006 @c Bonus for doc-source readers: you can also say --format=strange (or
3007 @c anything else that starts with 's') for sysv, and --format=boring (or
3008 @c anything else that starts with 'b') for Berkeley.
3010 Here is an example of the Berkeley (default) format of output from
3013 $ size --format=Berkeley ranlib size
3014 text data bss dec hex filename
3015 294880 81920 11592 388392 5ed28 ranlib
3016 294880 81920 11888 388688 5ee50 size
3019 The Berkeley style output counts read only data in the @code{text}
3020 column, not in the @code{data} column, the @code{dec} and @code{hex}
3021 columns both display the sum of the @code{text}, @code{data}, and
3022 @code{bss} columns in decimal and hexadecimal respectively.
3024 The GNU format counts read only data in the @code{data} column, not
3025 the @code{text} column, and only displays the sum of the @code{text},
3026 @code{data}, and @code{bss} columns once, in the @code{total} column.
3027 The @option{--radix} option can be used to change the number base for
3028 all columns. Here is the same data displayed with GNU conventions:
3031 $ size --format=GNU ranlib size
3032 text data bss total filename
3033 279880 96920 11592 388392 ranlib
3034 279880 96920 11888 388688 size
3038 This is the same data, but displayed closer to System V conventions:
3041 $ size --format=SysV ranlib size
3059 Show a summary of acceptable arguments and options.
3064 @itemx --radix=@var{number}
3065 @cindex @command{size} number format
3066 @cindex radix for section sizes
3067 Using one of these options, you can control whether the size of each
3068 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3069 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3070 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
3071 values (8, 10, 16) are supported. The total size is always given in two
3072 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3073 octal and hexadecimal if you're using @option{-o}.
3076 Print total size of common symbols in each file. When using Berkeley
3077 or GNU format these are included in the bss size.
3081 Show totals of all objects listed (Berkeley or GNU format mode only).
3083 @item --target=@var{bfdname}
3084 @cindex object code format
3085 Specify that the object-code format for @var{objfile} is
3086 @var{bfdname}. This option may not be necessary; @command{size} can
3087 automatically recognize many formats.
3088 @xref{Target Selection}, for more information.
3092 Display the version number of @command{size}.
3098 @c man begin SEEALSO size
3099 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3106 @cindex listings strings
3107 @cindex printing strings
3108 @cindex strings, printing
3110 @c man title strings print the sequences of printable characters in files
3113 @c man begin SYNOPSIS strings
3114 strings [@option{-afovV}] [@option{-}@var{min-len}]
3115 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3116 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3117 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3118 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3119 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3120 [@option{-w}] [@option{--include-all-whitespace}]
3121 [@option{-s}] [@option{--output-separator}@var{sep_string}]
3122 [@option{--help}] [@option{--version}] @var{file}@dots{}
3126 @c man begin DESCRIPTION strings
3128 For each @var{file} given, @sc{gnu} @command{strings} prints the
3129 printable character sequences that are at least 4 characters long (or
3130 the number given with the options below) and are followed by an
3131 unprintable character.
3133 Depending upon how the strings program was configured it will default
3134 to either displaying all the printable sequences that it can find in
3135 each file, or only those sequences that are in loadable, initialized
3136 data sections. If the file type in unrecognizable, or if strings is
3137 reading from stdin then it will always display all of the printable
3138 sequences that it can find.
3140 For backwards compatibility any file that occurs after a command-line
3141 option of just @option{-} will also be scanned in full, regardless of
3142 the presence of any @option{-d} option.
3144 @command{strings} is mainly useful for determining the contents of
3149 @c man begin OPTIONS strings
3155 Scan the whole file, regardless of what sections it contains or
3156 whether those sections are loaded or initialized. Normally this is
3157 the default behaviour, but strings can be configured so that the
3158 @option{-d} is the default instead.
3160 The @option{-} option is position dependent and forces strings to
3161 perform full scans of any file that is mentioned after the @option{-}
3162 on the command line, even if the @option{-d} option has been
3167 Only print strings from initialized, loaded data sections in the
3168 file. This may reduce the amount of garbage in the output, but it
3169 also exposes the strings program to any security flaws that may be
3170 present in the BFD library used to scan and load sections. Strings
3171 can be configured so that this option is the default behaviour. In
3172 such cases the @option{-a} option can be used to avoid using the BFD
3173 library and instead just print all of the strings found in the file.
3176 @itemx --print-file-name
3177 Print the name of the file before each string.
3180 Print a summary of the program usage on the standard output and exit.
3182 @item -@var{min-len}
3183 @itemx -n @var{min-len}
3184 @itemx --bytes=@var{min-len}
3185 Print sequences of characters that are at least @var{min-len} characters
3186 long, instead of the default 4.
3189 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
3190 act like @samp{-t d} instead. Since we can not be compatible with both
3191 ways, we simply chose one.
3193 @item -t @var{radix}
3194 @itemx --radix=@var{radix}
3195 Print the offset within the file before each string. The single
3196 character argument specifies the radix of the offset---@samp{o} for
3197 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3199 @item -e @var{encoding}
3200 @itemx --encoding=@var{encoding}
3201 Select the character encoding of the strings that are to be found.
3202 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3203 characters (ASCII, ISO 8859, etc., default), @samp{S} =
3204 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3205 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3206 littleendian. Useful for finding wide character strings. (@samp{l}
3207 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3209 @item -T @var{bfdname}
3210 @itemx --target=@var{bfdname}
3211 @cindex object code format
3212 Specify an object code format other than your system's default format.
3213 @xref{Target Selection}, for more information.
3218 Print the program version number on the standard output and exit.
3221 @itemx --include-all-whitespace
3222 By default tab and space characters are included in the strings that
3223 are displayed, but other whitespace characters, such a newlines and
3224 carriage returns, are not. The @option{-w} option changes this so
3225 that all whitespace characters are considered to be part of a string.
3228 @itemx --output-separator
3229 By default, output strings are delimited by a new-line. This option
3230 allows you to supply any string to be used as the output record
3231 separator. Useful with --include-all-whitespace where strings
3232 may contain new-lines internally.
3238 @c man begin SEEALSO strings
3239 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3240 and the Info entries for @file{binutils}.
3248 @cindex removing symbols
3249 @cindex discarding symbols
3250 @cindex symbols, discarding
3252 @c man title strip discard symbols and other data from object files
3255 @c man begin SYNOPSIS strip
3256 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3257 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3258 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3259 [@option{-s}|@option{--strip-all}]
3260 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3261 [@option{--strip-dwo}]
3262 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3263 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3264 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3265 [@option{-w}|@option{--wildcard}]
3266 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3267 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3268 [@option{--keep-section=}@var{sectionpattern}]
3269 [@option{--remove-relocations=}@var{sectionpattern}]
3270 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3271 [@option{-D}|@option{--enable-deterministic-archives}]
3272 [@option{-U}|@option{--disable-deterministic-archives}]
3273 [@option{--keep-file-symbols}]
3274 [@option{--only-keep-debug}]
3275 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3276 [@option{--help}] [@option{--info}]
3277 @var{objfile}@dots{}
3281 @c man begin DESCRIPTION strip
3283 @sc{gnu} @command{strip} discards all symbols from object files
3284 @var{objfile}. The list of object files may include archives.
3285 At least one object file must be given.
3287 @command{strip} modifies the files named in its argument,
3288 rather than writing modified copies under different names.
3292 @c man begin OPTIONS strip
3295 @item -F @var{bfdname}
3296 @itemx --target=@var{bfdname}
3297 Treat the original @var{objfile} as a file with the object
3298 code format @var{bfdname}, and rewrite it in the same format.
3299 @xref{Target Selection}, for more information.
3302 Show a summary of the options to @command{strip} and exit.
3305 Display a list showing all architectures and object formats available.
3307 @item -I @var{bfdname}
3308 @itemx --input-target=@var{bfdname}
3309 Treat the original @var{objfile} as a file with the object
3310 code format @var{bfdname}.
3311 @xref{Target Selection}, for more information.
3313 @item -O @var{bfdname}
3314 @itemx --output-target=@var{bfdname}
3315 Replace @var{objfile} with a file in the output format @var{bfdname}.
3316 @xref{Target Selection}, for more information.
3318 @item -R @var{sectionname}
3319 @itemx --remove-section=@var{sectionname}
3320 Remove any section named @var{sectionname} from the output file, in
3321 addition to whatever sections would otherwise be removed. This
3322 option may be given more than once. Note that using this option
3323 inappropriately may make the output file unusable. The wildcard
3324 character @samp{*} may be given at the end of @var{sectionname}. If
3325 so, then any section starting with @var{sectionname} will be removed.
3327 If the first character of @var{sectionpattern} is the exclamation
3328 point (!) then matching sections will not be removed even if an
3329 earlier use of @option{--remove-section} on the same command line
3330 would otherwise remove it. For example:
3333 --remove-section=.text.* --remove-section=!.text.foo
3336 will remove all sections matching the pattern '.text.*', but will not
3337 remove the section '.text.foo'.
3339 @item --keep-section=@var{sectionpattern}
3340 When removing sections from the output file, keep sections that match
3341 @var{sectionpattern}.
3343 @item --remove-relocations=@var{sectionpattern}
3344 Remove relocations from the output file for any section matching
3345 @var{sectionpattern}. This option may be given more than once. Note
3346 that using this option inappropriately may make the output file
3347 unusable. Wildcard characters are accepted in @var{sectionpattern}.
3351 --remove-relocations=.text.*
3354 will remove the relocations for all sections matching the patter
3357 If the first character of @var{sectionpattern} is the exclamation
3358 point (!) then matching sections will not have their relocation
3359 removed even if an earlier use of @option{--remove-relocations} on the
3360 same command line would otherwise cause the relocations to be removed.
3364 --remove-relocations=.text.* --remove-relocations=!.text.foo
3367 will remove all relocations for sections matching the pattern
3368 '.text.*', but will not remove relocations for the section
3378 @itemx --strip-debug
3379 Remove debugging symbols only.
3382 Remove the contents of all DWARF .dwo sections, leaving the
3383 remaining debugging sections and all symbols intact.
3384 See the description of this option in the @command{objcopy} section
3385 for more information.
3387 @item --strip-unneeded
3388 Remove all symbols that are not needed for relocation processing.
3390 @item -K @var{symbolname}
3391 @itemx --keep-symbol=@var{symbolname}
3392 When stripping symbols, keep symbol @var{symbolname} even if it would
3393 normally be stripped. This option may be given more than once.
3396 @itemx --merge-notes
3397 @itemx --no-merge-notes
3398 For ELF files, attempt (or do not attempt) to reduce the size of any
3399 SHT_NOTE type sections by removing duplicate notes. The default is to
3400 attempt this reduction unless stripping debug or DWO information.
3402 @item -N @var{symbolname}
3403 @itemx --strip-symbol=@var{symbolname}
3404 Remove symbol @var{symbolname} from the source file. This option may be
3405 given more than once, and may be combined with strip options other than
3409 Put the stripped output in @var{file}, rather than replacing the
3410 existing file. When this argument is used, only one @var{objfile}
3411 argument may be specified.
3414 @itemx --preserve-dates
3415 Preserve the access and modification dates of the file.
3418 @itemx --enable-deterministic-archives
3419 @cindex deterministic archives
3420 @kindex --enable-deterministic-archives
3421 Operate in @emph{deterministic} mode. When copying archive members
3422 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3423 and use consistent file modes for all files.
3425 If @file{binutils} was configured with
3426 @option{--enable-deterministic-archives}, then this mode is on by default.
3427 It can be disabled with the @samp{-U} option, below.
3430 @itemx --disable-deterministic-archives
3431 @cindex deterministic archives
3432 @kindex --enable-deterministic-archives
3433 Do @emph{not} operate in @emph{deterministic} mode. This is the
3434 inverse of the @option{-D} option, above: when copying archive members
3435 and writing the archive index, use their actual UID, GID, timestamp,
3436 and file mode values.
3438 This is the default unless @file{binutils} was configured with
3439 @option{--enable-deterministic-archives}.
3443 Permit regular expressions in @var{symbolname}s used in other command
3444 line options. The question mark (?), asterisk (*), backslash (\) and
3445 square brackets ([]) operators can be used anywhere in the symbol
3446 name. If the first character of the symbol name is the exclamation
3447 point (!) then the sense of the switch is reversed for that symbol.
3454 would cause strip to only keep symbols that start with the letters
3455 ``fo'', but to discard the symbol ``foo''.
3458 @itemx --discard-all
3459 Remove non-global symbols.
3462 @itemx --discard-locals
3463 Remove compiler-generated local symbols.
3464 (These usually start with @samp{L} or @samp{.}.)
3466 @item --keep-file-symbols
3467 When stripping a file, perhaps with @option{--strip-debug} or
3468 @option{--strip-unneeded}, retain any symbols specifying source file names,
3469 which would otherwise get stripped.
3471 @item --only-keep-debug
3472 Strip a file, emptying the contents of any sections that would not be
3473 stripped by @option{--strip-debug} and leaving the debugging sections
3474 intact. In ELF files, this preserves all the note sections in the
3477 Note - the section headers of the stripped sections are preserved,
3478 including their sizes, but the contents of the section are discarded.
3479 The section headers are preserved so that other tools can match up the
3480 debuginfo file with the real executable, even if that executable has
3481 been relocated to a different address space.
3483 The intention is that this option will be used in conjunction with
3484 @option{--add-gnu-debuglink} to create a two part executable. One a
3485 stripped binary which will occupy less space in RAM and in a
3486 distribution and the second a debugging information file which is only
3487 needed if debugging abilities are required. The suggested procedure
3488 to create these files is as follows:
3491 @item Link the executable as normal. Assuming that it is called
3493 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3494 create a file containing the debugging info.
3495 @item Run @code{objcopy --strip-debug foo} to create a
3496 stripped executable.
3497 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3498 to add a link to the debugging info into the stripped executable.
3501 Note---the choice of @code{.dbg} as an extension for the debug info
3502 file is arbitrary. Also the @code{--only-keep-debug} step is
3503 optional. You could instead do this:
3506 @item Link the executable as normal.
3507 @item Copy @code{foo} to @code{foo.full}
3508 @item Run @code{strip --strip-debug foo}
3509 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3512 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3513 full executable. It does not have to be a file created by the
3514 @option{--only-keep-debug} switch.
3516 Note---this switch is only intended for use on fully linked files. It
3517 does not make sense to use it on object files where the debugging
3518 information may be incomplete. Besides the gnu_debuglink feature
3519 currently only supports the presence of one filename containing
3520 debugging information, not multiple filenames on a one-per-object-file
3525 Show the version number for @command{strip}.
3529 Verbose output: list all object files modified. In the case of
3530 archives, @samp{strip -v} lists all members of the archive.
3536 @c man begin SEEALSO strip
3537 the Info entries for @file{binutils}.
3541 @node c++filt, addr2line, strip, Top
3545 @cindex demangling C++ symbols
3547 @c man title cxxfilt demangle C++ and Java symbols
3550 @c man begin SYNOPSIS cxxfilt
3551 c++filt [@option{-_}|@option{--strip-underscore}]
3552 [@option{-n}|@option{--no-strip-underscore}]
3553 [@option{-p}|@option{--no-params}]
3554 [@option{-t}|@option{--types}]
3555 [@option{-i}|@option{--no-verbose}]
3556 [@option{-r}|@option{--no-recurse-limit}]
3557 [@option{-R}|@option{--recurse-limit}]
3558 [@option{-s} @var{format}|@option{--format=}@var{format}]
3559 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3563 @c man begin DESCRIPTION cxxfilt
3566 The C++ and Java languages provide function overloading, which means
3567 that you can write many functions with the same name, providing that
3568 each function takes parameters of different types. In order to be
3569 able to distinguish these similarly named functions C++ and Java
3570 encode them into a low-level assembler name which uniquely identifies
3571 each different version. This process is known as @dfn{mangling}. The
3573 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3574 MS-DOS this program is named @command{CXXFILT}.}
3575 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3576 names into user-level names so that they can be read.
3578 Every alphanumeric word (consisting of letters, digits, underscores,
3579 dollars, or periods) seen in the input is a potential mangled name.
3580 If the name decodes into a C++ name, the C++ name replaces the
3581 low-level name in the output, otherwise the original word is output.
3582 In this way you can pass an entire assembler source file, containing
3583 mangled names, through @command{c++filt} and see the same source file
3584 containing demangled names.
3586 You can also use @command{c++filt} to decipher individual symbols by
3587 passing them on the command line:
3590 c++filt @var{symbol}
3593 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3594 names from the standard input instead. All the results are printed on
3595 the standard output. The difference between reading names from the
3596 command line versus reading names from the standard input is that
3597 command-line arguments are expected to be just mangled names and no
3598 checking is performed to separate them from surrounding text. Thus
3605 will work and demangle the name to ``f()'' whereas:
3611 will not work. (Note the extra comma at the end of the mangled
3612 name which makes it invalid). This command however will work:
3615 echo _Z1fv, | c++filt -n
3618 and will display ``f(),'', i.e., the demangled name followed by a
3619 trailing comma. This behaviour is because when the names are read
3620 from the standard input it is expected that they might be part of an
3621 assembler source file where there might be extra, extraneous
3622 characters trailing after a mangled name. For example:
3625 .type _Z1fv, @@function
3630 @c man begin OPTIONS cxxfilt
3634 @itemx --strip-underscore
3635 On some systems, both the C and C++ compilers put an underscore in front
3636 of every name. For example, the C name @code{foo} gets the low-level
3637 name @code{_foo}. This option removes the initial underscore. Whether
3638 @command{c++filt} removes the underscore by default is target dependent.
3641 @itemx --no-strip-underscore
3642 Do not remove the initial underscore.
3646 When demangling the name of a function, do not display the types of
3647 the function's parameters.
3651 Attempt to demangle types as well as function names. This is disabled
3652 by default since mangled types are normally only used internally in
3653 the compiler, and they can be confused with non-mangled names. For example,
3654 a function called ``a'' treated as a mangled type name would be
3655 demangled to ``signed char''.
3659 Do not include implementation details (if any) in the demangled
3664 @itemx --recurse-limit
3665 @itemx --no-recurse-limit
3666 @itemx --recursion-limit
3667 @itemx --no-recursion-limit
3668 Enables or disables a limit on the amount of recursion performed
3669 whilst demangling strings. Since the name mangling formats allow for
3670 an inifinite level of recursion it is possible to create strings whose
3671 decoding will exhaust the amount of stack space available on the host
3672 machine, triggering a memory fault. The limit tries to prevent this
3673 from happening by restricting recursion to 2048 levels of nesting.
3675 The default is for this limit to be enabled, but disabling it may be
3676 necessary in order to demangle truly complicated names. Note however
3677 that if the recursion limit is disabled then stack exhaustion is
3678 possible and any bug reports about such an event will be rejected.
3680 The @option{-r} option is a synonym for the
3681 @option{--no-recurse-limit} option. The @option{-R} option is a
3682 synonym for the @option{--recurse-limit} option.
3684 @item -s @var{format}
3685 @itemx --format=@var{format}
3686 @command{c++filt} can decode various methods of mangling, used by
3687 different compilers. The argument to this option selects which
3692 Automatic selection based on executable (the default method)
3694 the one used by the @sc{gnu} C++ compiler (g++)
3696 the one used by the Lucid compiler (lcc)
3698 the one specified by the C++ Annotated Reference Manual
3700 the one used by the HP compiler (aCC)
3702 the one used by the EDG compiler
3704 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3706 the one used by the @sc{gnu} Java compiler (gcj)
3708 the one used by the @sc{gnu} Ada compiler (GNAT).
3712 Print a summary of the options to @command{c++filt} and exit.
3715 Print the version number of @command{c++filt} and exit.
3721 @c man begin SEEALSO cxxfilt
3722 the Info entries for @file{binutils}.
3727 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3728 user interface are subject to change in future releases. In particular,
3729 a command-line option may be required in the future to decode a name
3730 passed as an argument on the command line; in other words,
3733 c++filt @var{symbol}
3737 may in a future release become
3740 c++filt @var{option} @var{symbol}
3748 @cindex address to file name and line number
3750 @c man title addr2line convert addresses into file names and line numbers
3753 @c man begin SYNOPSIS addr2line
3754 addr2line [@option{-a}|@option{--addresses}]
3755 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3756 [@option{-C}|@option{--demangle}[=@var{style}]]
3757 [@option{-r}|@option{--no-recurse-limit}]
3758 [@option{-R}|@option{--recurse-limit}]
3759 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3760 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3761 [@option{-i}|@option{--inlines}]
3762 [@option{-p}|@option{--pretty-print}]
3763 [@option{-j}|@option{--section=}@var{name}]
3764 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3769 @c man begin DESCRIPTION addr2line
3771 @command{addr2line} translates addresses into file names and line numbers.
3772 Given an address in an executable or an offset in a section of a relocatable
3773 object, it uses the debugging information to figure out which file name and
3774 line number are associated with it.
3776 The executable or relocatable object to use is specified with the @option{-e}
3777 option. The default is the file @file{a.out}. The section in the relocatable
3778 object to use is specified with the @option{-j} option.
3780 @command{addr2line} has two modes of operation.
3782 In the first, hexadecimal addresses are specified on the command line,
3783 and @command{addr2line} displays the file name and line number for each
3786 In the second, @command{addr2line} reads hexadecimal addresses from
3787 standard input, and prints the file name and line number for each
3788 address on standard output. In this mode, @command{addr2line} may be used
3789 in a pipe to convert dynamically chosen addresses.
3791 The format of the output is @samp{FILENAME:LINENO}. By default
3792 each input address generates one line of output.
3794 Two options can generate additional lines before each
3795 @samp{FILENAME:LINENO} line (in that order).
3797 If the @option{-a} option is used then a line with the input address
3800 If the @option{-f} option is used, then a line with the
3801 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3802 containing the address.
3804 One option can generate additional lines after the
3805 @samp{FILENAME:LINENO} line.
3807 If the @option{-i} option is used and the code at the given address is
3808 present there because of inlining by the compiler then additional
3809 lines are displayed afterwards. One or two extra lines (if the
3810 @option{-f} option is used) are displayed for each inlined function.
3812 Alternatively if the @option{-p} option is used then each input
3813 address generates a single, long, output line containing the address,
3814 the function name, the file name and the line number. If the
3815 @option{-i} option has also been used then any inlined functions will
3816 be displayed in the same manner, but on separate lines, and prefixed
3817 by the text @samp{(inlined by)}.
3819 If the file name or function name can not be determined,
3820 @command{addr2line} will print two question marks in their place. If the
3821 line number can not be determined, @command{addr2line} will print 0.
3825 @c man begin OPTIONS addr2line
3827 The long and short forms of options, shown here as alternatives, are
3833 Display the address before the function name, file and line number
3834 information. The address is printed with a @samp{0x} prefix to easily
3837 @item -b @var{bfdname}
3838 @itemx --target=@var{bfdname}
3839 @cindex object code format
3840 Specify that the object-code format for the object files is
3844 @itemx --demangle[=@var{style}]
3845 @cindex demangling in objdump
3846 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3847 Besides removing any initial underscore prepended by the system, this
3848 makes C++ function names readable. Different compilers have different
3849 mangling styles. The optional demangling style argument can be used to
3850 choose an appropriate demangling style for your compiler. @xref{c++filt},
3851 for more information on demangling.
3853 @item -e @var{filename}
3854 @itemx --exe=@var{filename}
3855 Specify the name of the executable for which addresses should be
3856 translated. The default file is @file{a.out}.
3860 Display function names as well as file and line number information.
3864 Display only the base of each file name.
3868 If the address belongs to a function that was inlined, the source
3869 information for all enclosing scopes back to the first non-inlined
3870 function will also be printed. For example, if @code{main} inlines
3871 @code{callee1} which inlines @code{callee2}, and address is from
3872 @code{callee2}, the source information for @code{callee1} and @code{main}
3873 will also be printed.
3877 Read offsets relative to the specified section instead of absolute addresses.
3880 @itemx --pretty-print
3881 Make the output more human friendly: each location are printed on one line.
3882 If option @option{-i} is specified, lines for all enclosing scopes are
3883 prefixed with @samp{(inlined by)}.
3887 @itemx --recurse-limit
3888 @itemx --no-recurse-limit
3889 @itemx --recursion-limit
3890 @itemx --no-recursion-limit
3891 Enables or disables a limit on the amount of recursion performed
3892 whilst demangling strings. Since the name mangling formats allow for
3893 an inifinite level of recursion it is possible to create strings whose
3894 decoding will exhaust the amount of stack space available on the host
3895 machine, triggering a memory fault. The limit tries to prevent this
3896 from happening by restricting recursion to 2048 levels of nesting.
3898 The default is for this limit to be enabled, but disabling it may be
3899 necessary in order to demangle truly complicated names. Note however
3900 that if the recursion limit is disabled then stack exhaustion is
3901 possible and any bug reports about such an event will be rejected.
3903 The @option{-r} option is a synonym for the
3904 @option{--no-recurse-limit} option. The @option{-R} option is a
3905 synonym for the @option{--recurse-limit} option.
3907 Note this option is only effective if the @option{-C} or
3908 @option{--demangle} option has been enabled.
3915 @c man begin SEEALSO addr2line
3916 Info entries for @file{binutils}.
3923 @command{windmc} may be used to generator Windows message resources.
3926 @emph{Warning:} @command{windmc} is not always built as part of the binary
3927 utilities, since it is only useful for Windows targets.
3930 @c man title windmc generates Windows message resources
3933 @c man begin SYNOPSIS windmc
3934 windmc [options] input-file
3938 @c man begin DESCRIPTION windmc
3940 @command{windmc} reads message definitions from an input file (.mc) and
3941 translate them into a set of output files. The output files may be of
3946 A C header file containing the message definitions.
3949 A resource file compilable by the @command{windres} tool.
3952 One or more binary files containing the resource data for a specific
3956 A C include file that maps message id's to their symbolic name.
3959 The exact description of these different formats is available in
3960 documentation from Microsoft.
3962 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3963 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3964 Windows Message Compiler.
3968 @c man begin OPTIONS windmc
3973 Specifies that the input file specified is ASCII. This is the default
3978 Specifies that messages in the output @code{bin} files should be in ASCII
3983 Specifies that @code{bin} filenames should have to be prefixed by the
3984 basename of the source file.
3988 Sets the customer bit in all message id's.
3990 @item -C @var{codepage}
3991 @itemx --codepage_in @var{codepage}
3992 Sets the default codepage to be used to convert input file to UTF16. The
3993 default is ocdepage 1252.
3996 @itemx --decimal_values
3997 Outputs the constants in the header file in decimal. Default is using
4001 @itemx --extension @var{ext}
4002 The extension for the header file. The default is .h extension.
4004 @item -F @var{target}
4005 @itemx --target @var{target}
4006 Specify the BFD format to use for a bin file as output. This
4007 is a BFD target name; you can use the @option{--help} option to see a list
4008 of supported targets. Normally @command{windmc} will use the default
4009 format, which is the first one listed by the @option{--help} option.
4011 @ref{Target Selection}.
4015 @itemx --headerdir @var{path}
4016 The target directory of the generated header file. The default is the
4021 Displays a list of command-line options and then exits.
4023 @item -m @var{characters}
4024 @itemx --maxlength @var{characters}
4025 Instructs @command{windmc} to generate a warning if the length
4026 of any message exceeds the number specified.
4029 @itemx --nullterminate
4030 Terminate message text in @code{bin} files by zero. By default they are
4031 terminated by CR/LF.
4034 @itemx --hresult_use
4035 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
4036 file, using HRESULT definitions. Status codes are used if the flag is not
4039 @item -O @var{codepage}
4040 @itemx --codepage_out @var{codepage}
4041 Sets the default codepage to be used to output text files. The default
4045 @itemx --rcdir @var{path}
4046 The target directory for the generated @code{rc} script and the generated
4047 @code{bin} files that the resource compiler script includes. The default
4048 is the current directory.
4052 Specifies that the input file is UTF16.
4055 @itemx --unicode_out
4056 Specifies that messages in the output @code{bin} file should be in UTF16
4057 format. This is the default behaviour.
4061 Enable verbose mode.
4065 Prints the version number for @command{windmc}.
4068 @itemx --xdgb @var{path}
4069 The path of the @code{dbg} C include file that maps message id's to the
4070 symbolic name. No such file is generated without specifying the switch.
4076 @c man begin SEEALSO windmc
4077 the Info entries for @file{binutils}.
4084 @command{windres} may be used to manipulate Windows resources.
4087 @emph{Warning:} @command{windres} is not always built as part of the binary
4088 utilities, since it is only useful for Windows targets.
4091 @c man title windres manipulate Windows resources
4094 @c man begin SYNOPSIS windres
4095 windres [options] [input-file] [output-file]
4099 @c man begin DESCRIPTION windres
4101 @command{windres} reads resources from an input file and copies them into
4102 an output file. Either file may be in one of three formats:
4106 A text format read by the Resource Compiler.
4109 A binary format generated by the Resource Compiler.
4112 A COFF object or executable.
4115 The exact description of these different formats is available in
4116 documentation from Microsoft.
4118 When @command{windres} converts from the @code{rc} format to the @code{res}
4119 format, it is acting like the Windows Resource Compiler. When
4120 @command{windres} converts from the @code{res} format to the @code{coff}
4121 format, it is acting like the Windows @code{CVTRES} program.
4123 When @command{windres} generates an @code{rc} file, the output is similar
4124 but not identical to the format expected for the input. When an input
4125 @code{rc} file refers to an external filename, an output @code{rc} file
4126 will instead include the file contents.
4128 If the input or output format is not specified, @command{windres} will
4129 guess based on the file name, or, for the input file, the file contents.
4130 A file with an extension of @file{.rc} will be treated as an @code{rc}
4131 file, a file with an extension of @file{.res} will be treated as a
4132 @code{res} file, and a file with an extension of @file{.o} or
4133 @file{.exe} will be treated as a @code{coff} file.
4135 If no output file is specified, @command{windres} will print the resources
4136 in @code{rc} format to standard output.
4138 The normal use is for you to write an @code{rc} file, use @command{windres}
4139 to convert it to a COFF object file, and then link the COFF file into
4140 your application. This will make the resources described in the
4141 @code{rc} file available to Windows.
4145 @c man begin OPTIONS windres
4148 @item -i @var{filename}
4149 @itemx --input @var{filename}
4150 The name of the input file. If this option is not used, then
4151 @command{windres} will use the first non-option argument as the input file
4152 name. If there are no non-option arguments, then @command{windres} will
4153 read from standard input. @command{windres} can not read a COFF file from
4156 @item -o @var{filename}
4157 @itemx --output @var{filename}
4158 The name of the output file. If this option is not used, then
4159 @command{windres} will use the first non-option argument, after any used
4160 for the input file name, as the output file name. If there is no
4161 non-option argument, then @command{windres} will write to standard output.
4162 @command{windres} can not write a COFF file to standard output. Note,
4163 for compatibility with @command{rc} the option @option{-fo} is also
4164 accepted, but its use is not recommended.
4166 @item -J @var{format}
4167 @itemx --input-format @var{format}
4168 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
4169 @samp{coff}. If no input format is specified, @command{windres} will
4170 guess, as described above.
4172 @item -O @var{format}
4173 @itemx --output-format @var{format}
4174 The output format to generate. @var{format} may be @samp{res},
4175 @samp{rc}, or @samp{coff}. If no output format is specified,
4176 @command{windres} will guess, as described above.
4178 @item -F @var{target}
4179 @itemx --target @var{target}
4180 Specify the BFD format to use for a COFF file as input or output. This
4181 is a BFD target name; you can use the @option{--help} option to see a list
4182 of supported targets. Normally @command{windres} will use the default
4183 format, which is the first one listed by the @option{--help} option.
4185 @ref{Target Selection}.
4188 @item --preprocessor @var{program}
4189 When @command{windres} reads an @code{rc} file, it runs it through the C
4190 preprocessor first. This option may be used to specify the preprocessor
4191 to use, including any leading arguments. The default preprocessor
4192 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4194 @item --preprocessor-arg @var{option}
4195 When @command{windres} reads an @code{rc} file, it runs it through
4196 the C preprocessor first. This option may be used to specify additional
4197 text to be passed to preprocessor on its command line.
4198 This option can be used multiple times to add multiple options to the
4199 preprocessor command line.
4201 @item -I @var{directory}
4202 @itemx --include-dir @var{directory}
4203 Specify an include directory to use when reading an @code{rc} file.
4204 @command{windres} will pass this to the preprocessor as an @option{-I}
4205 option. @command{windres} will also search this directory when looking for
4206 files named in the @code{rc} file. If the argument passed to this command
4207 matches any of the supported @var{formats} (as described in the @option{-J}
4208 option), it will issue a deprecation warning, and behave just like the
4209 @option{-J} option. New programs should not use this behaviour. If a
4210 directory happens to match a @var{format}, simple prefix it with @samp{./}
4211 to disable the backward compatibility.
4213 @item -D @var{target}
4214 @itemx --define @var{sym}[=@var{val}]
4215 Specify a @option{-D} option to pass to the preprocessor when reading an
4218 @item -U @var{target}
4219 @itemx --undefine @var{sym}
4220 Specify a @option{-U} option to pass to the preprocessor when reading an
4224 Ignored for compatibility with rc.
4227 Enable verbose mode. This tells you what the preprocessor is if you
4231 @item --codepage @var{val}
4232 Specify the default codepage to use when reading an @code{rc} file.
4233 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4234 codepage code. The valid range is from zero up to 0xffff, but the
4235 validity of the codepage is host and configuration dependent.
4238 @item --language @var{val}
4239 Specify the default language to use when reading an @code{rc} file.
4240 @var{val} should be a hexadecimal language code. The low eight bits are
4241 the language, and the high eight bits are the sublanguage.
4243 @item --use-temp-file
4244 Use a temporary file to instead of using popen to read the output of
4245 the preprocessor. Use this option if the popen implementation is buggy
4246 on the host (eg., certain non-English language versions of Windows 95 and
4247 Windows 98 are known to have buggy popen where the output will instead
4250 @item --no-use-temp-file
4251 Use popen, not a temporary file, to read the output of the preprocessor.
4252 This is the default behaviour.
4256 Prints a usage summary.
4260 Prints the version number for @command{windres}.
4263 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4264 this will turn on parser debugging.
4270 @c man begin SEEALSO windres
4271 the Info entries for @file{binutils}.
4280 @command{dlltool} is used to create the files needed to create dynamic
4281 link libraries (DLLs) on systems which understand PE format image
4282 files such as Windows. A DLL contains an export table which contains
4283 information that the runtime loader needs to resolve references from a
4284 referencing program.
4286 The export table is generated by this program by reading in a
4287 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4288 will be in the DLL. A @file{.o} file can contain information in
4289 special @samp{.drectve} sections with export information.
4292 @emph{Note:} @command{dlltool} is not always built as part of the
4293 binary utilities, since it is only useful for those targets which
4297 @c man title dlltool create files needed to build and use DLLs
4300 @c man begin SYNOPSIS dlltool
4301 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4302 [@option{-b}|@option{--base-file} @var{base-file-name}]
4303 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4304 [@option{-z}|@option{--output-def} @var{def-file-name}]
4305 [@option{-l}|@option{--output-lib} @var{library-file-name}]
4306 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4307 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4308 [@option{--exclude-symbols} @var{list}]
4309 [@option{--no-default-excludes}]
4310 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4311 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4312 [@option{-a}|@option{--add-indirect}]
4313 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4314 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4315 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4316 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4317 [@option{--use-nul-prefixed-import-tables}]
4318 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4319 [@option{-i}|@option{--interwork}]
4320 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4321 [@option{-v}|@option{--verbose}]
4322 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4323 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4324 [object-file @dots{}]
4328 @c man begin DESCRIPTION dlltool
4330 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4331 @option{-b} options as well as object files specified on the command
4332 line. It then processes these inputs and if the @option{-e} option has
4333 been specified it creates a exports file. If the @option{-l} option
4334 has been specified it creates a library file and if the @option{-z} option
4335 has been specified it creates a def file. Any or all of the @option{-e},
4336 @option{-l} and @option{-z} options can be present in one invocation of
4339 When creating a DLL, along with the source for the DLL, it is necessary
4340 to have three other files. @command{dlltool} can help with the creation of
4343 The first file is a @file{.def} file which specifies which functions are
4344 exported from the DLL, which functions the DLL imports, and so on. This
4345 is a text file and can be created by hand, or @command{dlltool} can be used
4346 to create it using the @option{-z} option. In this case @command{dlltool}
4347 will scan the object files specified on its command line looking for
4348 those functions which have been specially marked as being exported and
4349 put entries for them in the @file{.def} file it creates.
4351 In order to mark a function as being exported from a DLL, it needs to
4352 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4353 section of the object file. This can be done in C by using the
4357 asm (".section .drectve");
4358 asm (".ascii \"-export:my_func\"");
4360 int my_func (void) @{ @dots{} @}
4363 The second file needed for DLL creation is an exports file. This file
4364 is linked with the object files that make up the body of the DLL and it
4365 handles the interface between the DLL and the outside world. This is a
4366 binary file and it can be created by giving the @option{-e} option to
4367 @command{dlltool} when it is creating or reading in a @file{.def} file.
4369 The third file needed for DLL creation is the library file that programs
4370 will link with in order to access the functions in the DLL (an `import
4371 library'). This file can be created by giving the @option{-l} option to
4372 dlltool when it is creating or reading in a @file{.def} file.
4374 If the @option{-y} option is specified, dlltool generates a delay-import
4375 library that can be used instead of the normal import library to allow
4376 a program to link to the dll only as soon as an imported function is
4377 called for the first time. The resulting executable will need to be
4378 linked to the static delayimp library containing __delayLoadHelper2(),
4379 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4381 @command{dlltool} builds the library file by hand, but it builds the
4382 exports file by creating temporary files containing assembler statements
4383 and then assembling these. The @option{-S} command-line option can be
4384 used to specify the path to the assembler that dlltool will use,
4385 and the @option{-f} option can be used to pass specific flags to that
4386 assembler. The @option{-n} can be used to prevent dlltool from deleting
4387 these temporary assembler files when it is done, and if @option{-n} is
4388 specified twice then this will prevent dlltool from deleting the
4389 temporary object files it used to build the library.
4391 Here is an example of creating a DLL from a source file @samp{dll.c} and
4392 also creating a program (from an object file called @samp{program.o})
4397 dlltool -e exports.o -l dll.lib dll.o
4398 gcc dll.o exports.o -o dll.dll
4399 gcc program.o dll.lib -o program
4403 @command{dlltool} may also be used to query an existing import library
4404 to determine the name of the DLL to which it is associated. See the
4405 description of the @option{-I} or @option{--identify} option.
4409 @c man begin OPTIONS dlltool
4411 The command-line options have the following meanings:
4415 @item -d @var{filename}
4416 @itemx --input-def @var{filename}
4417 @cindex input .def file
4418 Specifies the name of a @file{.def} file to be read in and processed.
4420 @item -b @var{filename}
4421 @itemx --base-file @var{filename}
4423 Specifies the name of a base file to be read in and processed. The
4424 contents of this file will be added to the relocation section in the
4425 exports file generated by dlltool.
4427 @item -e @var{filename}
4428 @itemx --output-exp @var{filename}
4429 Specifies the name of the export file to be created by dlltool.
4431 @item -z @var{filename}
4432 @itemx --output-def @var{filename}
4433 Specifies the name of the @file{.def} file to be created by dlltool.
4435 @item -l @var{filename}
4436 @itemx --output-lib @var{filename}
4437 Specifies the name of the library file to be created by dlltool.
4439 @item -y @var{filename}
4440 @itemx --output-delaylib @var{filename}
4441 Specifies the name of the delay-import library file to be created by dlltool.
4443 @item --export-all-symbols
4444 Treat all global and weak defined symbols found in the input object
4445 files as symbols to be exported. There is a small list of symbols which
4446 are not exported by default; see the @option{--no-default-excludes}
4447 option. You may add to the list of symbols to not export by using the
4448 @option{--exclude-symbols} option.
4450 @item --no-export-all-symbols
4451 Only export symbols explicitly listed in an input @file{.def} file or in
4452 @samp{.drectve} sections in the input object files. This is the default
4453 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4454 attributes in the source code.
4456 @item --exclude-symbols @var{list}
4457 Do not export the symbols in @var{list}. This is a list of symbol names
4458 separated by comma or colon characters. The symbol names should not
4459 contain a leading underscore. This is only meaningful when
4460 @option{--export-all-symbols} is used.
4462 @item --no-default-excludes
4463 When @option{--export-all-symbols} is used, it will by default avoid
4464 exporting certain special symbols. The current list of symbols to avoid
4465 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4466 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4467 to go ahead and export these special symbols. This is only meaningful
4468 when @option{--export-all-symbols} is used.
4471 @itemx --as @var{path}
4472 Specifies the path, including the filename, of the assembler to be used
4473 to create the exports file.
4475 @item -f @var{options}
4476 @itemx --as-flags @var{options}
4477 Specifies any specific command-line options to be passed to the
4478 assembler when building the exports file. This option will work even if
4479 the @option{-S} option is not used. This option only takes one argument,
4480 and if it occurs more than once on the command line, then later
4481 occurrences will override earlier occurrences. So if it is necessary to
4482 pass multiple options to the assembler they should be enclosed in
4486 @itemx --dll-name @var{name}
4487 Specifies the name to be stored in the @file{.def} file as the name of
4488 the DLL when the @option{-e} option is used. If this option is not
4489 present, then the filename given to the @option{-e} option will be
4490 used as the name of the DLL.
4492 @item -m @var{machine}
4493 @itemx -machine @var{machine}
4494 Specifies the type of machine for which the library file should be
4495 built. @command{dlltool} has a built in default type, depending upon how
4496 it was created, but this option can be used to override that. This is
4497 normally only useful when creating DLLs for an ARM processor, when the
4498 contents of the DLL are actually encode using Thumb instructions.
4501 @itemx --add-indirect
4502 Specifies that when @command{dlltool} is creating the exports file it
4503 should add a section which allows the exported functions to be
4504 referenced without using the import library. Whatever the hell that
4508 @itemx --add-underscore
4509 Specifies that when @command{dlltool} is creating the exports file it
4510 should prepend an underscore to the names of @emph{all} exported symbols.
4512 @item --no-leading-underscore
4513 @item --leading-underscore
4514 Specifies whether standard symbol should be forced to be prefixed, or
4517 @item --add-stdcall-underscore
4518 Specifies that when @command{dlltool} is creating the exports file it
4519 should prepend an underscore to the names of exported @emph{stdcall}
4520 functions. Variable names and non-stdcall function names are not modified.
4521 This option is useful when creating GNU-compatible import libs for third
4522 party DLLs that were built with MS-Windows tools.
4526 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4527 of stdcall functions that will be imported from the DLL. This is
4528 useful when creating an import library for a DLL which exports stdcall
4529 functions but without the usual @samp{@@<number>} symbol name suffix.
4531 This does not change the naming of symbols provided by the import library
4532 to programs linked against it, but only the entries in the import table
4533 (ie the .idata section).
4536 @itemx --add-stdcall-alias
4537 Specifies that when @command{dlltool} is creating the exports file it
4538 should add aliases for stdcall symbols without @samp{@@ <number>}
4539 in addition to the symbols with @samp{@@ <number>}.
4542 @itemx --ext-prefix-alias @var{prefix}
4543 Causes @command{dlltool} to create external aliases for all DLL
4544 imports with the specified prefix. The aliases are created for both
4545 external and import symbols with no leading underscore.
4549 Specifies that when @command{dlltool} is creating the exports and library
4550 files it should omit the @code{.idata4} section. This is for compatibility
4551 with certain operating systems.
4553 @item --use-nul-prefixed-import-tables
4554 Specifies that when @command{dlltool} is creating the exports and library
4555 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4556 element. This emulates old gnu import library generation of
4557 @code{dlltool}. By default this option is turned off.
4561 Specifies that when @command{dlltool} is creating the exports and library
4562 files it should omit the @code{.idata5} section. This is for compatibility
4563 with certain operating systems.
4565 @item -I @var{filename}
4566 @itemx --identify @var{filename}
4567 Specifies that @command{dlltool} should inspect the import library
4568 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4569 of the associated DLL(s). This can be performed in addition to any
4570 other operations indicated by the other options and arguments.
4571 @command{dlltool} fails if the import library does not exist or is not
4572 actually an import library. See also @option{--identify-strict}.
4574 @item --identify-strict
4575 Modifies the behavior of the @option{--identify} option, such
4576 that an error is reported if @var{filename} is associated with
4581 Specifies that @command{dlltool} should mark the objects in the library
4582 file and exports file that it produces as supporting interworking
4583 between ARM and Thumb code.
4587 Makes @command{dlltool} preserve the temporary assembler files it used to
4588 create the exports file. If this option is repeated then dlltool will
4589 also preserve the temporary object files it uses to create the library
4592 @item -t @var{prefix}
4593 @itemx --temp-prefix @var{prefix}
4594 Makes @command{dlltool} use @var{prefix} when constructing the names of
4595 temporary assembler and object files. By default, the temp file prefix
4596 is generated from the pid.
4600 Make dlltool describe what it is doing.
4604 Displays a list of command-line options and then exits.
4608 Displays dlltool's version number and then exits.
4615 * def file format:: The format of the dlltool @file{.def} file
4618 @node def file format
4619 @section The format of the @command{dlltool} @file{.def} file
4621 A @file{.def} file contains any number of the following commands:
4625 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4626 The result is going to be named @var{name}@code{.exe}.
4628 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4629 The result is going to be named @var{name}@code{.dll}.
4630 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4631 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4634 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4635 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4636 Declares @var{name1} as an exported symbol from the DLL, with optional
4637 ordinal number @var{integer}, or declares @var{name1} as an alias
4638 (forward) of the function @var{external-name} in the DLL.
4639 If @var{its_name} is specified, this name is used as string in export table.
4641 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4642 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4643 If you want to use LIBRARY as name then you need to quote it.
4645 @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{]} *}
4646 Declares that @var{external-name} or the exported function whose
4647 ordinal number is @var{integer} is to be imported from the file
4648 @var{module-name}. If @var{internal-name} is specified then this is
4649 the name that the imported function will be referred to in the body of
4651 If @var{its_name} is specified, this name is used as string in import table.
4652 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4653 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4654 If you want to use LIBRARY as name then you need to quote it.
4656 @item @code{DESCRIPTION} @var{string}
4657 Puts @var{string} into the output @file{.exp} file in the
4658 @code{.rdata} section.
4660 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4661 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4662 Generates @code{--stack} or @code{--heap}
4663 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4664 section. The linker will see this and act upon it.
4666 @item @code{CODE} @var{attr} @code{+}
4667 @item @code{DATA} @var{attr} @code{+}
4668 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4669 Generates @code{--attr} @var{section-name} @var{attr} in the output
4670 @code{.drectve} section, where @var{attr} is one of @code{READ},
4671 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4672 this and act upon it.
4677 @c man begin SEEALSO dlltool
4678 The Info pages for @file{binutils}.
4685 @cindex ELF file information
4688 @c man title readelf display information about ELF files
4691 @c man begin SYNOPSIS readelf
4692 readelf [@option{-a}|@option{--all}]
4693 [@option{-h}|@option{--file-header}]
4694 [@option{-l}|@option{--program-headers}|@option{--segments}]
4695 [@option{-S}|@option{--section-headers}|@option{--sections}]
4696 [@option{-g}|@option{--section-groups}]
4697 [@option{-t}|@option{--section-details}]
4698 [@option{-e}|@option{--headers}]
4699 [@option{-s}|@option{--syms}|@option{--symbols}]
4700 [@option{--dyn-syms}]
4701 [@option{-n}|@option{--notes}]
4702 [@option{-r}|@option{--relocs}]
4703 [@option{-u}|@option{--unwind}]
4704 [@option{-d}|@option{--dynamic}]
4705 [@option{-V}|@option{--version-info}]
4706 [@option{-A}|@option{--arch-specific}]
4707 [@option{-D}|@option{--use-dynamic}]
4708 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4709 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4710 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4711 [@option{-z}|@option{--decompress}]
4712 [@option{-c}|@option{--archive-index}]
4713 [@option{-w[lLiaprmfFsoRtUuTgAckK]}|
4714 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
4715 [@option{--dwarf-depth=@var{n}}]
4716 [@option{--dwarf-start=@var{n}}]
4717 [@option{--ctf=}@var{section}]
4718 [@option{--ctf-parent=}@var{section}]
4719 [@option{--ctf-symbols=}@var{section}]
4720 [@option{--ctf-strings=}@var{section}]
4721 [@option{-I}|@option{--histogram}]
4722 [@option{-v}|@option{--version}]
4723 [@option{-W}|@option{--wide}]
4724 [@option{-H}|@option{--help}]
4725 @var{elffile}@dots{}
4729 @c man begin DESCRIPTION readelf
4731 @command{readelf} displays information about one or more ELF format object
4732 files. The options control what particular information to display.
4734 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4735 64-bit ELF files are supported, as are archives containing ELF files.
4737 This program performs a similar function to @command{objdump} but it
4738 goes into more detail and it exists independently of the @sc{bfd}
4739 library, so if there is a bug in @sc{bfd} then readelf will not be
4744 @c man begin OPTIONS readelf
4746 The long and short forms of options, shown here as alternatives, are
4747 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4753 Equivalent to specifying @option{--file-header},
4754 @option{--program-headers}, @option{--sections}, @option{--symbols},
4755 @option{--relocs}, @option{--dynamic}, @option{--notes},
4756 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
4757 @option{--section-groups} and @option{--histogram}.
4759 Note - this option does not enable @option{--use-dynamic} itself, so
4760 if that option is not present on the command line then dynamic symbols
4761 and dynamic relocs will not be displayed.
4764 @itemx --file-header
4765 @cindex ELF file header information
4766 Displays the information contained in the ELF header at the start of the
4770 @itemx --program-headers
4772 @cindex ELF program header information
4773 @cindex ELF segment information
4774 Displays the information contained in the file's segment headers, if it
4779 @itemx --section-headers
4780 @cindex ELF section information
4781 Displays the information contained in the file's section headers, if it
4785 @itemx --section-groups
4786 @cindex ELF section group information
4787 Displays the information contained in the file's section groups, if it
4791 @itemx --section-details
4792 @cindex ELF section information
4793 Displays the detailed section information. Implies @option{-S}.
4798 @cindex ELF symbol table information
4799 Displays the entries in symbol table section of the file, if it has one.
4800 If a symbol has version information associated with it then this is
4801 displayed as well. The version string is displayed as a suffix to the
4802 symbol name, preceeded by an @@ character. For example
4803 @samp{foo@@VER_1}. If the version is the default version to be used
4804 when resolving unversioned references to the symbol then it is
4805 displayed as a suffix preceeded by two @@ characters. For example
4806 @samp{foo@@@@VER_2}.
4809 @cindex ELF dynamic symbol table information
4810 Displays the entries in dynamic symbol table section of the file, if it
4811 has one. The output format is the same as the format used by the
4812 @option{--syms} option.
4816 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4821 Displays the contents of the NOTE segments and/or sections, if any.
4825 @cindex ELF reloc information
4826 Displays the contents of the file's relocation section, if it has one.
4830 @cindex unwind information
4831 Displays the contents of the file's unwind section, if it has one. Only
4832 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4833 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported. If
4834 support is not yet implemented for your architecture you could try
4835 dumping the contents of the @var{.eh_frames} section using the
4836 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
4841 @cindex ELF dynamic section information
4842 Displays the contents of the file's dynamic section, if it has one.
4845 @itemx --version-info
4846 @cindex ELF version sections information
4847 Displays the contents of the version sections in the file, it they
4851 @itemx --arch-specific
4852 Displays architecture-specific information in the file, if there
4856 @itemx --use-dynamic
4857 When displaying symbols, this option makes @command{readelf} use the
4858 symbol hash tables in the file's dynamic section, rather than the
4859 symbol table sections.
4861 When displaying relocations, this option makes @command{readelf}
4862 display the dynamic relocations rather than the static relocations.
4864 @item -x <number or name>
4865 @itemx --hex-dump=<number or name>
4866 Displays the contents of the indicated section as a hexadecimal bytes.
4867 A number identifies a particular section by index in the section table;
4868 any other string identifies all sections with that name in the object file.
4870 @item -R <number or name>
4871 @itemx --relocated-dump=<number or name>
4872 Displays the contents of the indicated section as a hexadecimal
4873 bytes. A number identifies a particular section by index in the
4874 section table; any other string identifies all sections with that name
4875 in the object file. The contents of the section will be relocated
4876 before they are displayed.
4878 @item -p <number or name>
4879 @itemx --string-dump=<number or name>
4880 Displays the contents of the indicated section as printable strings.
4881 A number identifies a particular section by index in the section table;
4882 any other string identifies all sections with that name in the object file.
4886 Requests that the section(s) being dumped by @option{x}, @option{R} or
4887 @option{p} options are decompressed before being displayed. If the
4888 section(s) are not compressed then they are displayed as is.
4891 @itemx --archive-index
4892 @cindex Archive file symbol index information
4893 Displays the file symbol index information contained in the header part
4894 of binary archives. Performs the same function as the @option{t}
4895 command to @command{ar}, but without using the BFD library. @xref{ar}.
4897 @item -w[lLiaprmfFsoRtUuTgAckK]
4898 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
4899 @include debug.options.texi
4901 @include ctf.options.texi
4902 @item --ctf-symbols=@var{section}
4903 @item --ctf-strings=@var{section}
4904 Specify the name of another section from which the CTF file can inherit
4905 strings and symbols. By default, the @code{.symtab} and its linked
4906 string table are used.
4908 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
4909 other must be specified as well.
4913 Display a histogram of bucket list lengths when displaying the contents
4914 of the symbol tables.
4918 Display the version number of readelf.
4922 Don't break output lines to fit into 80 columns. By default
4923 @command{readelf} breaks section header and segment listing lines for
4924 64-bit ELF files, so that they fit into 80 columns. This option causes
4925 @command{readelf} to print each section header resp. each segment one a
4926 single line, which is far more readable on terminals wider than 80 columns.
4930 Display the command-line options understood by @command{readelf}.
4937 @c man begin SEEALSO readelf
4938 objdump(1), and the Info entries for @file{binutils}.
4945 @cindex Update ELF header
4948 @c man title elfedit update ELF header and program property of ELF files
4951 @c man begin SYNOPSIS elfedit
4952 elfedit [@option{--input-mach=}@var{machine}]
4953 [@option{--input-type=}@var{type}]
4954 [@option{--input-osabi=}@var{osabi}]
4955 @option{--output-mach=}@var{machine}
4956 @option{--output-type=}@var{type}
4957 @option{--output-osabi=}@var{osabi}
4958 @option{--enable-x86-feature=}@var{feature}
4959 @option{--disable-x86-feature=}@var{feature}
4960 [@option{-v}|@option{--version}]
4961 [@option{-h}|@option{--help}]
4962 @var{elffile}@dots{}
4966 @c man begin DESCRIPTION elfedit
4968 @command{elfedit} updates the ELF header and program property of ELF
4969 files which have the matching ELF machine and file types. The options
4970 control how and which fields in the ELF header and program property
4973 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4974 64-bit ELF files are supported, as are archives containing ELF files.
4977 @c man begin OPTIONS elfedit
4979 The long and short forms of options, shown here as alternatives, are
4980 equivalent. At least one of the @option{--output-mach},
4981 @option{--output-type}, @option{--output-osabi},
4982 @option{--enable-x86-feature} and @option{--disable-x86-feature}
4983 options must be given.
4987 @item --input-mach=@var{machine}
4988 Set the matching input ELF machine type to @var{machine}. If
4989 @option{--input-mach} isn't specified, it will match any ELF
4992 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4993 @var{K1OM} and @var{x86-64}.
4995 @item --output-mach=@var{machine}
4996 Change the ELF machine type in the ELF header to @var{machine}. The
4997 supported ELF machine types are the same as @option{--input-mach}.
4999 @item --input-type=@var{type}
5000 Set the matching input ELF file type to @var{type}. If
5001 @option{--input-type} isn't specified, it will match any ELF file types.
5003 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
5005 @item --output-type=@var{type}
5006 Change the ELF file type in the ELF header to @var{type}. The
5007 supported ELF types are the same as @option{--input-type}.
5009 @item --input-osabi=@var{osabi}
5010 Set the matching input ELF file OSABI to @var{osabi}. If
5011 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
5013 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
5014 @var{GNU}, @var{Linux} (alias for @var{GNU}),
5015 @var{Solaris}, @var{AIX}, @var{Irix},
5016 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
5017 @var{NSK}, @var{AROS} and @var{FenixOS}.
5019 @item --output-osabi=@var{osabi}
5020 Change the ELF OSABI in the ELF header to @var{osabi}. The
5021 supported ELF OSABI are the same as @option{--input-osabi}.
5023 @item --enable-x86-feature=@var{feature}
5024 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
5025 ELF files with machine types of @var{i386} or @var{x86-64}. The
5026 supported features are, @var{ibt} and @var{shstk}.
5028 @item --disable-x86-feature=@var{feature}
5029 Clear the @var{feature} bit in program property in @var{exec} or
5030 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
5031 The supported features are the same as @option{--enable-x86-feature}.
5033 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
5034 are available only on hosts with @samp{mmap} support.
5038 Display the version number of @command{elfedit}.
5042 Display the command-line options understood by @command{elfedit}.
5049 @c man begin SEEALSO elfedit
5050 readelf(1), and the Info entries for @file{binutils}.
5054 @node Common Options
5055 @chapter Common Options
5057 The following command-line options are supported by all of the
5058 programs described in this manual.
5060 @c man begin OPTIONS
5062 @include at-file.texi
5066 Display the command-line options supported by the program.
5069 Display the version number of the program.
5071 @c man begin OPTIONS
5075 @node Selecting the Target System
5076 @chapter Selecting the Target System
5078 You can specify two aspects of the target system to the @sc{gnu}
5079 binary file utilities, each in several ways:
5089 In the following summaries, the lists of ways to specify values are in
5090 order of decreasing precedence. The ways listed first override those
5093 The commands to list valid values only list the values for which the
5094 programs you are running were configured. If they were configured with
5095 @option{--enable-targets=all}, the commands list most of the available
5096 values, but a few are left out; not all targets can be configured in at
5097 once because some of them can only be configured @dfn{native} (on hosts
5098 with the same type as the target system).
5101 * Target Selection::
5102 * Architecture Selection::
5105 @node Target Selection
5106 @section Target Selection
5108 A @dfn{target} is an object file format. A given target may be
5109 supported for multiple architectures (@pxref{Architecture Selection}).
5110 A target selection may also have variations for different operating
5111 systems or architectures.
5113 The command to list valid target values is @samp{objdump -i}
5114 (the first column of output contains the relevant information).
5116 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5117 @samp{a.out-sunos-big}.
5119 You can also specify a target using a configuration triplet. This is
5120 the same sort of name that is passed to @file{configure} to specify a
5121 target. When you use a configuration triplet as an argument, it must be
5122 fully canonicalized. You can see the canonical version of a triplet by
5123 running the shell script @file{config.sub} which is included with the
5126 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5127 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5129 @subheading @command{objdump} Target
5135 command-line option: @option{-b} or @option{--target}
5138 environment variable @code{GNUTARGET}
5141 deduced from the input file
5144 @subheading @command{objcopy} and @command{strip} Input Target
5150 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5153 environment variable @code{GNUTARGET}
5156 deduced from the input file
5159 @subheading @command{objcopy} and @command{strip} Output Target
5165 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5168 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5171 environment variable @code{GNUTARGET}
5174 deduced from the input file
5177 @subheading @command{nm}, @command{size}, and @command{strings} Target
5183 command-line option: @option{--target}
5186 environment variable @code{GNUTARGET}
5189 deduced from the input file
5192 @node Architecture Selection
5193 @section Architecture Selection
5195 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5196 to run. Its name may contain a colon, separating the name of the
5197 processor family from the name of the particular @sc{cpu}.
5199 The command to list valid architecture values is @samp{objdump -i} (the
5200 second column contains the relevant information).
5202 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5204 @subheading @command{objdump} Architecture
5210 command-line option: @option{-m} or @option{--architecture}
5213 deduced from the input file
5216 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5222 deduced from the input file
5227 @cindex separate debug files
5229 debuginfod is a web service that indexes ELF/DWARF debugging resources
5230 by build-id and serves them over HTTP.
5232 Binutils can be built with the debuginfod client library
5233 @code{libdebuginfod} using the @option{--with-debuginfod} configure option.
5234 This option is enabled by default if @code{libdebuginfod} is installed
5235 and found at configure time. This allows @command{objdump} and
5236 @command{readelf} to automatically query debuginfod servers for
5237 separate debug files when the files are otherwise not found.
5239 debuginfod is packaged with elfutils, starting with version 0.178.
5240 You can get the latest version from `https://sourceware.org/elfutils/'.
5242 @node Reporting Bugs
5243 @chapter Reporting Bugs
5245 @cindex reporting bugs
5247 Your bug reports play an essential role in making the binary utilities
5250 Reporting a bug may help you by bringing a solution to your problem, or
5251 it may not. But in any case the principal function of a bug report is
5252 to help the entire community by making the next version of the binary
5253 utilities work better. Bug reports are your contribution to their
5256 In order for a bug report to serve its purpose, you must include the
5257 information that enables us to fix the bug.
5260 * Bug Criteria:: Have you found a bug?
5261 * Bug Reporting:: How to report bugs
5265 @section Have You Found a Bug?
5266 @cindex bug criteria
5268 If you are not sure whether you have found a bug, here are some guidelines:
5271 @cindex fatal signal
5274 If a binary utility gets a fatal signal, for any input whatever, that is
5275 a bug. Reliable utilities never crash.
5277 @cindex error on valid input
5279 If a binary utility produces an error message for valid input, that is a
5283 If you are an experienced user of binary utilities, your suggestions for
5284 improvement are welcome in any case.
5288 @section How to Report Bugs
5290 @cindex bugs, reporting
5292 A number of companies and individuals offer support for @sc{gnu}
5293 products. If you obtained the binary utilities from a support
5294 organization, we recommend you contact that organization first.
5296 You can find contact information for many support companies and
5297 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5301 In any event, we also recommend that you send bug reports for the binary
5302 utilities to @value{BUGURL}.
5305 The fundamental principle of reporting bugs usefully is this:
5306 @strong{report all the facts}. If you are not sure whether to state a
5307 fact or leave it out, state it!
5309 Often people omit facts because they think they know what causes the
5310 problem and assume that some details do not matter. Thus, you might
5311 assume that the name of a file you use in an example does not matter.
5312 Well, probably it does not, but one cannot be sure. Perhaps the bug is
5313 a stray memory reference which happens to fetch from the location where
5314 that pathname is stored in memory; perhaps, if the pathname were
5315 different, the contents of that location would fool the utility into
5316 doing the right thing despite the bug. Play it safe and give a
5317 specific, complete example. That is the easiest thing for you to do,
5318 and the most helpful.
5320 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5321 it is new to us. Therefore, always write your bug reports on the assumption
5322 that the bug has not been reported previously.
5324 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5325 bell?'' This cannot help us fix a bug, so it is basically useless. We
5326 respond by asking for enough details to enable us to investigate.
5327 You might as well expedite matters by sending them to begin with.
5329 To enable us to fix the bug, you should include all these things:
5333 The version of the utility. Each utility announces it if you start it
5334 with the @option{--version} argument.
5336 Without this, we will not know whether there is any point in looking for
5337 the bug in the current version of the binary utilities.
5340 Any patches you may have applied to the source, including any patches
5341 made to the @code{BFD} library.
5344 The type of machine you are using, and the operating system name and
5348 What compiler (and its version) was used to compile the utilities---e.g.
5352 The command arguments you gave the utility to observe the bug. To
5353 guarantee you will not omit something important, list them all. A copy
5354 of the Makefile (or the output from make) is sufficient.
5356 If we were to try to guess the arguments, we would probably guess wrong
5357 and then we might not encounter the bug.
5360 A complete input file, or set of input files, that will reproduce the
5361 bug. If the utility is reading an object file or files, then it is
5362 generally most helpful to send the actual object files.
5364 If the source files were produced exclusively using @sc{gnu} programs
5365 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5366 may be OK to send the source files rather than the object files. In
5367 this case, be sure to say exactly what version of @command{gcc}, or
5368 whatever, was used to produce the object files. Also say how
5369 @command{gcc}, or whatever, was configured.
5372 A description of what behavior you observe that you believe is
5373 incorrect. For example, ``It gets a fatal signal.''
5375 Of course, if the bug is that the utility gets a fatal signal, then we
5376 will certainly notice it. But if the bug is incorrect output, we might
5377 not notice unless it is glaringly wrong. You might as well not give us
5378 a chance to make a mistake.
5380 Even if the problem you experience is a fatal signal, you should still
5381 say so explicitly. Suppose something strange is going on, such as your
5382 copy of the utility is out of sync, or you have encountered a bug in
5383 the C library on your system. (This has happened!) Your copy might
5384 crash and ours would not. If you told us to expect a crash, then when
5385 ours fails to crash, we would know that the bug was not happening for
5386 us. If you had not told us to expect a crash, then we would not be able
5387 to draw any conclusion from our observations.
5390 If you wish to suggest changes to the source, send us context diffs, as
5391 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5392 option. Always send diffs from the old file to the new file. If you
5393 wish to discuss something in the @command{ld} source, refer to it by
5394 context, not by line number.
5396 The line numbers in our development sources will not match those in your
5397 sources. Your line numbers would convey no useful information to us.
5400 Here are some things that are not necessary:
5404 A description of the envelope of the bug.
5406 Often people who encounter a bug spend a lot of time investigating
5407 which changes to the input file will make the bug go away and which
5408 changes will not affect it.
5410 This is often time consuming and not very useful, because the way we
5411 will find the bug is by running a single example under the debugger
5412 with breakpoints, not by pure deduction from a series of examples.
5413 We recommend that you save your time for something else.
5415 Of course, if you can find a simpler example to report @emph{instead}
5416 of the original one, that is a convenience for us. Errors in the
5417 output will be easier to spot, running under the debugger will take
5418 less time, and so on.
5420 However, simplification is not vital; if you do not want to do this,
5421 report the bug anyway and send us the entire test case you used.
5424 A patch for the bug.
5426 A patch for the bug does help us if it is a good one. But do not omit
5427 the necessary information, such as the test case, on the assumption that
5428 a patch is all we need. We might see problems with your patch and decide
5429 to fix the problem another way, or we might not understand it at all.
5431 Sometimes with programs as complicated as the binary utilities it is
5432 very hard to construct an example that will make the program follow a
5433 certain path through the code. If you do not send us the example, we
5434 will not be able to construct one, so we will not be able to verify that
5437 And if we cannot understand what bug you are trying to fix, or why your
5438 patch should be an improvement, we will not install it. A test case will
5439 help us to understand.
5442 A guess about what the bug is or what it depends on.
5444 Such guesses are usually wrong. Even we cannot guess right about such
5445 things without first using the debugger to find the facts.
5448 @node GNU Free Documentation License
5449 @appendix GNU Free Documentation License
5453 @node Binutils Index
5454 @unnumbered Binutils Index