1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2013 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 * nlmconv: (binutils)nlmconv. Converts object code into an NLM.
38 * nm: (binutils)nm. List symbols from object files.
39 * objcopy: (binutils)objcopy. Copy and translate object files.
40 * objdump: (binutils)objdump. Display information from object files.
41 * ranlib: (binutils)ranlib. Generate index to archive contents.
42 * readelf: (binutils)readelf. Display the contents of ELF format files.
43 * size: (binutils)size. List section sizes and total size.
44 * strings: (binutils)strings. List printable strings from files.
45 * strip: (binutils)strip. Discard symbols.
46 * elfedit: (binutils)elfedit. Update the ELF header of ELF files.
47 * windmc: (binutils)windmc. Generator for Windows message resources.
48 * windres: (binutils)windres. Manipulate Windows resources.
52 @title The @sc{gnu} Binary Utilities
53 @ifset VERSION_PACKAGE
54 @subtitle @value{VERSION_PACKAGE}
56 @subtitle Version @value{VERSION}
58 @subtitle @value{UPDATED}
59 @author Roland H. Pesch
60 @author Jeffrey M. Osier
61 @author Cygnus Support
65 {\parskip=0pt \hfill Cygnus Support\par \hfill
66 Texinfo \texinfoversion\par }
69 @vskip 0pt plus 1filll
78 This brief manual contains documentation for the @sc{gnu} binary
80 @ifset VERSION_PACKAGE
81 @value{VERSION_PACKAGE}
83 version @value{VERSION}:
88 Create, modify, and extract from archives
91 List symbols from object files
94 Copy and translate object files
97 Display information from object files
100 Generate index to archive contents
103 Display the contents of ELF format files.
106 List file section sizes and total size
109 List printable strings from files
115 Update the ELF header of ELF files.
118 Demangle encoded C++ symbols (on MS-DOS, this program is named
122 Convert addresses into file names and line numbers
125 Convert object code into a Netware Loadable Module
128 Manipulate Windows resources
131 Generator for Windows message resources
134 Create the files needed to build and use Dynamic Link Libraries
138 This document is distributed under the terms of the GNU Free
139 Documentation License version 1.3. A copy of the license is included
140 in the section entitled ``GNU Free Documentation License''.
143 * ar:: Create, modify, and extract from archives
144 * nm:: List symbols from object files
145 * objcopy:: Copy and translate object files
146 * objdump:: Display information from object files
147 * ranlib:: Generate index to archive contents
148 * size:: List section sizes and total size
149 * strings:: List printable strings from files
150 * strip:: Discard symbols
151 * c++filt:: Filter to demangle encoded C++ symbols
152 * cxxfilt: c++filt. MS-DOS name for c++filt
153 * addr2line:: Convert addresses to file and line
154 * nlmconv:: Converts object code into an NLM
155 * windmc:: Generator for Windows message resources
156 * windres:: Manipulate Windows resources
157 * dlltool:: Create files needed to build and use DLLs
158 * readelf:: Display the contents of ELF format files
159 * elfedit:: Update the ELF header of ELF files
160 * Common Options:: Command-line options for all utilities
161 * Selecting the Target System:: How these utilities determine the target
162 * Reporting Bugs:: Reporting Bugs
163 * GNU Free Documentation License:: GNU Free Documentation License
164 * Binutils Index:: Binutils Index
172 @cindex collections of files
174 @c man title ar create, modify, and extract from archives
177 ar [@option{--plugin} @var{name}] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] [@option{--target} @var{bfdname}] @var{archive} [@var{member}@dots{}]
178 ar -M [ <mri-script ]
181 @c man begin DESCRIPTION ar
183 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
184 archives. An @dfn{archive} is a single file holding a collection of
185 other files in a structure that makes it possible to retrieve
186 the original individual files (called @dfn{members} of the archive).
188 The original files' contents, mode (permissions), timestamp, owner, and
189 group are preserved in the archive, and can be restored on
193 @sc{gnu} @command{ar} can maintain archives whose members have names of any
194 length; however, depending on how @command{ar} is configured on your
195 system, a limit on member-name length may be imposed for compatibility
196 with archive formats maintained with other tools. If it exists, the
197 limit is often 15 characters (typical of formats related to a.out) or 16
198 characters (typical of formats related to coff).
201 @command{ar} is considered a binary utility because archives of this sort
202 are most often used as @dfn{libraries} holding commonly needed
206 @command{ar} creates an index to the symbols defined in relocatable
207 object modules in the archive when you specify the modifier @samp{s}.
208 Once created, this index is updated in the archive whenever @command{ar}
209 makes a change to its contents (save for the @samp{q} update operation).
210 An archive with such an index speeds up linking to the library, and
211 allows routines in the library to call each other without regard to
212 their placement in the archive.
214 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
215 table. If an archive lacks the table, another form of @command{ar} called
216 @command{ranlib} can be used to add just the table.
218 @cindex thin archives
219 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
220 which contains a symbol index and references to the original copies
221 of the member files of the archive. This is useful for building
222 libraries for use within a local build tree, where the relocatable
223 objects are expected to remain available, and copying the contents of
224 each object would only waste time and space.
226 An archive can either be @emph{thin} or it can be normal. It cannot
227 be both at the same time. Once an archive is created its format
228 cannot be changed without first deleting it and then creating a new
229 archive in its place.
231 Thin archives are also @emph{flattened}, so that adding one thin
232 archive to another thin archive does not nest it, as would happen with
233 a normal archive. Instead the elements of the first archive are added
234 individually to the second archive.
236 The paths to the elements of the archive are stored relative to the
239 @cindex compatibility, @command{ar}
240 @cindex @command{ar} compatibility
241 @sc{gnu} @command{ar} is designed to be compatible with two different
242 facilities. You can control its activity using command-line options,
243 like the different varieties of @command{ar} on Unix systems; or, if you
244 specify the single command-line option @option{-M}, you can control it
245 with a script supplied via standard input, like the MRI ``librarian''
251 * ar cmdline:: Controlling @command{ar} on the command line
252 * ar scripts:: Controlling @command{ar} with a script
257 @section Controlling @command{ar} on the Command Line
260 @c man begin SYNOPSIS ar
261 ar [@option{--plugin} @var{name}] [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] [@option{--target} @var{bfdname}] @var{archive} [@var{member}@dots{}]
265 @cindex Unix compatibility, @command{ar}
266 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
267 arguments to execute: one keyletter specifying the @emph{operation}
268 (optionally accompanied by other keyletters specifying
269 @emph{modifiers}), and the archive name to act on.
271 Most operations can also accept further @var{member} arguments,
272 specifying particular files to operate on.
274 @c man begin OPTIONS ar
276 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
277 flags @var{mod} in any order, within the first command-line argument.
279 If you wish, you may begin the first command-line argument with a
282 @cindex operations on archive
283 The @var{p} keyletter specifies what operation to execute; it may be
284 any of the following, but you must specify only one of them:
288 @cindex deleting from archive
289 @emph{Delete} modules from the archive. Specify the names of modules to
290 be deleted as @var{member}@dots{}; the archive is untouched if you
291 specify no files to delete.
293 If you specify the @samp{v} modifier, @command{ar} lists each module
297 @cindex moving in archive
298 Use this operation to @emph{move} members in an archive.
300 The ordering of members in an archive can make a difference in how
301 programs are linked using the library, if a symbol is defined in more
304 If no modifiers are used with @code{m}, any members you name in the
305 @var{member} arguments are moved to the @emph{end} of the archive;
306 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
307 specified place instead.
310 @cindex printing from archive
311 @emph{Print} the specified members of the archive, to the standard
312 output file. If the @samp{v} modifier is specified, show the member
313 name before copying its contents to standard output.
315 If you specify no @var{member} arguments, all the files in the archive are
319 @cindex quick append to archive
320 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
321 @var{archive}, without checking for replacement.
323 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
324 operation; new members are always placed at the end of the archive.
326 The modifier @samp{v} makes @command{ar} list each file as it is appended.
328 Since the point of this operation is speed, implementations of
329 @command{ar} have the option of not updating the archive's symbol
330 table if one exists. Too many different systems however assume that
331 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
332 rebuild the table even with a quick append.
334 Note - @sc{gnu} @command{ar} treats the command @samp {qs} as a
335 synonym for @samp{r} - replacing already existing files in the
336 archive and appending new ones at the end.
339 @cindex replacement in archive
340 Insert the files @var{member}@dots{} into @var{archive} (with
341 @emph{replacement}). This operation differs from @samp{q} in that any
342 previously existing members are deleted if their names match those being
345 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
346 displays an error message, and leaves undisturbed any existing members
347 of the archive matching that name.
349 By default, new members are added at the end of the file; but you may
350 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
351 placement relative to some existing member.
353 The modifier @samp{v} used with this operation elicits a line of
354 output for each file inserted, along with one of the letters @samp{a} or
355 @samp{r} to indicate whether the file was appended (no old member
356 deleted) or replaced.
360 Add an index to the archive, or update it if it already exists. Note
361 this command is an exception to the rule that there can only be one
362 command letter, as it is possible to use it as either a command or a
363 modifier. In either case it does the same thing.
366 @cindex contents of archive
367 Display a @emph{table} listing the contents of @var{archive}, or those
368 of the files listed in @var{member}@dots{} that are present in the
369 archive. Normally only the member name is shown; if you also want to
370 see the modes (permissions), timestamp, owner, group, and size, you can
371 request that by also specifying the @samp{v} modifier.
373 If you do not specify a @var{member}, all files in the archive
376 @cindex repeated names in archive
377 @cindex name duplication in archive
378 If there is more than one file with the same name (say, @samp{fie}) in
379 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
380 first instance; to see them all, you must ask for a complete
381 listing---in our example, @samp{ar t b.a}.
382 @c WRS only; per Gumby, this is implementation-dependent, and in a more
383 @c recent case in fact works the other way.
386 @cindex extract from archive
387 @emph{Extract} members (named @var{member}) from the archive. You can
388 use the @samp{v} modifier with this operation, to request that
389 @command{ar} list each name as it extracts it.
391 If you do not specify a @var{member}, all files in the archive
394 Files cannot be extracted from a thin archive.
397 Displays the list of command line options supported by @command{ar}
401 Displays the version information of @command{ar} and then exits.
405 A number of modifiers (@var{mod}) may immediately follow the @var{p}
406 keyletter, to specify variations on an operation's behavior:
410 @cindex relative placement in archive
411 Add new files @emph{after} an existing member of the
412 archive. If you use the modifier @samp{a}, the name of an existing archive
413 member must be present as the @var{relpos} argument, before the
414 @var{archive} specification.
417 Add new files @emph{before} an existing member of the
418 archive. If you use the modifier @samp{b}, the name of an existing archive
419 member must be present as the @var{relpos} argument, before the
420 @var{archive} specification. (same as @samp{i}).
423 @cindex creating archives
424 @emph{Create} the archive. The specified @var{archive} is always
425 created if it did not exist, when you request an update. But a warning is
426 issued unless you specify in advance that you expect to create it, by
430 @cindex deterministic archives
431 @kindex --enable-deterministic-archives
432 Operate in @emph{deterministic} mode. When adding files and the archive
433 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
434 for all files. When this option is used, if @command{ar} is used with
435 identical options and identical input files, multiple runs will create
436 identical output files regardless of the input files' owners, groups,
437 file modes, or modification times.
439 If @file{binutils} was configured with
440 @option{--enable-deterministic-archives}, then this mode is on by default.
441 It can be disabled with the @samp{U} modifier, below.
444 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
445 names of any length. This will cause it to create archives which are
446 not compatible with the native @command{ar} program on some systems. If
447 this is a concern, the @samp{f} modifier may be used to truncate file
448 names when putting them in the archive.
451 Insert new files @emph{before} an existing member of the
452 archive. If you use the modifier @samp{i}, the name of an existing archive
453 member must be present as the @var{relpos} argument, before the
454 @var{archive} specification. (same as @samp{b}).
457 This modifier is accepted but not used.
458 @c whaffor ar l modifier??? presumably compat; with
459 @c what???---doc@@cygnus.com, 25jan91
462 Uses the @var{count} parameter. This is used if there are multiple
463 entries in the archive with the same name. Extract or delete instance
464 @var{count} of the given name from the archive.
467 @cindex dates in archive
468 Preserve the @emph{original} dates of members when extracting them. If
469 you do not specify this modifier, files extracted from the archive
470 are stamped with the time of extraction.
473 Use the full path name when matching names in the archive. @sc{gnu}
474 @command{ar} can not create an archive with a full path name (such archives
475 are not POSIX complaint), but other archive creators can. This option
476 will cause @sc{gnu} @command{ar} to match file names using a complete path
477 name, which can be convenient when extracting a single file from an
478 archive created by another tool.
481 @cindex writing archive index
482 Write an object-file index into the archive, or update an existing one,
483 even if no other change is made to the archive. You may use this modifier
484 flag either with any operation, or alone. Running @samp{ar s} on an
485 archive is equivalent to running @samp{ranlib} on it.
488 @cindex not writing archive index
489 Do not generate an archive symbol table. This can speed up building a
490 large library in several steps. The resulting archive can not be used
491 with the linker. In order to build a symbol table, you must omit the
492 @samp{S} modifier on the last execution of @samp{ar}, or you must run
493 @samp{ranlib} on the archive.
496 @cindex creating thin archive
497 Make the specified @var{archive} a @emph{thin} archive. If it already
498 exists and is a regular archive, the existing members must be present
499 in the same directory as @var{archive}.
502 @cindex updating an archive
503 Normally, @samp{ar r}@dots{} inserts all files
504 listed into the archive. If you would like to insert @emph{only} those
505 of the files you list that are newer than existing members of the same
506 names, use this modifier. The @samp{u} modifier is allowed only for the
507 operation @samp{r} (replace). In particular, the combination @samp{qu} is
508 not allowed, since checking the timestamps would lose any speed
509 advantage from the operation @samp{q}.
512 @cindex deterministic archives
513 @kindex --enable-deterministic-archives
514 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
515 of the @samp{D} modifier, above: added files and the archive index will
516 get their actual UID, GID, timestamp, and file mode values.
518 This is the default unless @file{binutils} was configured with
519 @option{--enable-deterministic-archives}.
522 This modifier requests the @emph{verbose} version of an operation. Many
523 operations display additional information, such as filenames processed,
524 when the modifier @samp{v} is appended.
527 This modifier shows the version number of @command{ar}.
530 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
531 compatibility with AIX. The behaviour produced by this option is the
532 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
533 @samp{-X} options; in particular, it does not support @option{-X32}
534 which is the default for AIX @command{ar}.
536 The optional command line switch @option{--plugin} @var{name} causes
537 @command{ar} to load the plugin called @var{name} which adds support
538 for more file formats. This option is only available if the toolchain
539 has been built with plugin support enabled.
541 The optional command line switch @option{--target} @var{bfdname}
542 specifies that the archive members are in an object code format
543 different from your system's default format. See
544 @xref{Target Selection}, for more information.
549 @c man begin SEEALSO ar
550 nm(1), ranlib(1), and the Info entries for @file{binutils}.
555 @section Controlling @command{ar} with a Script
558 ar -M [ <@var{script} ]
561 @cindex MRI compatibility, @command{ar}
562 @cindex scripts, @command{ar}
563 If you use the single command-line option @samp{-M} with @command{ar}, you
564 can control its operation with a rudimentary command language. This
565 form of @command{ar} operates interactively if standard input is coming
566 directly from a terminal. During interactive use, @command{ar} prompts for
567 input (the prompt is @samp{AR >}), and continues executing even after
568 errors. If you redirect standard input to a script file, no prompts are
569 issued, and @command{ar} abandons execution (with a nonzero exit code)
572 The @command{ar} command language is @emph{not} designed to be equivalent
573 to the command-line options; in fact, it provides somewhat less control
574 over archives. The only purpose of the command language is to ease the
575 transition to @sc{gnu} @command{ar} for developers who already have scripts
576 written for the MRI ``librarian'' program.
578 The syntax for the @command{ar} command language is straightforward:
581 commands are recognized in upper or lower case; for example, @code{LIST}
582 is the same as @code{list}. In the following descriptions, commands are
583 shown in upper case for clarity.
586 a single command may appear on each line; it is the first word on the
590 empty lines are allowed, and have no effect.
593 comments are allowed; text after either of the characters @samp{*}
594 or @samp{;} is ignored.
597 Whenever you use a list of names as part of the argument to an @command{ar}
598 command, you can separate the individual names with either commas or
599 blanks. Commas are shown in the explanations below, for clarity.
602 @samp{+} is used as a line continuation character; if @samp{+} appears
603 at the end of a line, the text on the following line is considered part
604 of the current command.
607 Here are the commands you can use in @command{ar} scripts, or when using
608 @command{ar} interactively. Three of them have special significance:
610 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
611 a temporary file required for most of the other commands.
613 @code{SAVE} commits the changes so far specified by the script. Prior
614 to @code{SAVE}, commands affect only the temporary copy of the current
618 @item ADDLIB @var{archive}
619 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
620 Add all the contents of @var{archive} (or, if specified, each named
621 @var{module} from @var{archive}) to the current archive.
623 Requires prior use of @code{OPEN} or @code{CREATE}.
625 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
626 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
627 @c else like "ar q..."
628 Add each named @var{member} as a module in the current archive.
630 Requires prior use of @code{OPEN} or @code{CREATE}.
633 Discard the contents of the current archive, canceling the effect of
634 any operations since the last @code{SAVE}. May be executed (with no
635 effect) even if no current archive is specified.
637 @item CREATE @var{archive}
638 Creates an archive, and makes it the current archive (required for many
639 other commands). The new archive is created with a temporary name; it
640 is not actually saved as @var{archive} until you use @code{SAVE}.
641 You can overwrite existing archives; similarly, the contents of any
642 existing file named @var{archive} will not be destroyed until @code{SAVE}.
644 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
645 Delete each listed @var{module} from the current archive; equivalent to
646 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
648 Requires prior use of @code{OPEN} or @code{CREATE}.
650 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
651 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
652 List each named @var{module} present in @var{archive}. The separate
653 command @code{VERBOSE} specifies the form of the output: when verbose
654 output is off, output is like that of @samp{ar -t @var{archive}
655 @var{module}@dots{}}. When verbose output is on, the listing is like
656 @samp{ar -tv @var{archive} @var{module}@dots{}}.
658 Output normally goes to the standard output stream; however, if you
659 specify @var{outputfile} as a final argument, @command{ar} directs the
663 Exit from @command{ar}, with a @code{0} exit code to indicate successful
664 completion. This command does not save the output file; if you have
665 changed the current archive since the last @code{SAVE} command, those
668 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
669 Extract each named @var{module} from the current archive, writing them
670 into the current directory as separate files. Equivalent to @samp{ar -x
671 @var{archive} @var{module}@dots{}}.
673 Requires prior use of @code{OPEN} or @code{CREATE}.
676 @c FIXME Tokens but no commands???
683 Display full contents of the current archive, in ``verbose'' style
684 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
685 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
686 enhancement, rather than present for MRI compatibility.)
688 Requires prior use of @code{OPEN} or @code{CREATE}.
690 @item OPEN @var{archive}
691 Opens an existing archive for use as the current archive (required for
692 many other commands). Any changes as the result of subsequent commands
693 will not actually affect @var{archive} until you next use @code{SAVE}.
695 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
696 In the current archive, replace each existing @var{module} (named in
697 the @code{REPLACE} arguments) from files in the current working directory.
698 To execute this command without errors, both the file, and the module in
699 the current archive, must exist.
701 Requires prior use of @code{OPEN} or @code{CREATE}.
704 Toggle an internal flag governing the output from @code{DIRECTORY}.
705 When the flag is on, @code{DIRECTORY} output matches output from
706 @samp{ar -tv }@dots{}.
709 Commit your changes to the current archive, and actually save it as a
710 file with the name specified in the last @code{CREATE} or @code{OPEN}
713 Requires prior use of @code{OPEN} or @code{CREATE}.
722 The @sc{gnu} linker @command{ld} is now described in a separate manual.
723 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
731 @c man title nm list symbols from object files
734 @c man begin SYNOPSIS nm
735 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
736 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
737 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
738 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
739 [@option{-l}|@option{--line-numbers}] [@option{-n}|@option{-v}|@option{--numeric-sort}]
740 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
741 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
742 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
743 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
744 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
745 [@option{--plugin} @var{name}] [@option{--size-sort}] [@option{--special-syms}]
746 [@option{--synthetic}] [@option{--target=}@var{bfdname}]
747 [@var{objfile}@dots{}]
751 @c man begin DESCRIPTION nm
752 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
753 If no object files are listed as arguments, @command{nm} assumes the file
756 For each symbol, @command{nm} shows:
760 The symbol value, in the radix selected by options (see below), or
761 hexadecimal by default.
764 The symbol type. At least the following types are used; others are, as
765 well, depending on the object file format. If lowercase, the symbol is
766 usually local; if uppercase, the symbol is global (external). There
767 are however a few lowercase symbols that are shown for special global
768 symbols (@code{u}, @code{v} and @code{w}).
770 @c Some more detail on exactly what these symbol types are used for
774 The symbol's value is absolute, and will not be changed by further
779 The symbol is in the uninitialized data section (known as BSS).
782 The symbol is common. Common symbols are uninitialized data. When
783 linking, multiple common symbols may appear with the same name. If the
784 symbol is defined anywhere, the common symbols are treated as undefined
787 For more details on common symbols, see the discussion of
788 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
793 The symbol is in the initialized data section.
797 The symbol is in an initialized data section for small objects. Some
798 object file formats permit more efficient access to small data objects,
799 such as a global int variable as opposed to a large global array.
802 For PE format files this indicates that the symbol is in a section
803 specific to the implementation of DLLs. For ELF format files this
804 indicates that the symbol is an indirect function. This is a GNU
805 extension to the standard set of ELF symbol types. It indicates a
806 symbol which if referenced by a relocation does not evaluate to its
807 address, but instead must be invoked at runtime. The runtime
808 execution will then return the value to be used in the relocation.
811 The symbol is a debugging symbol.
814 The symbols is in a stack unwind section.
818 The symbol is in a read only data section.
822 The symbol is in an uninitialized data section for small objects.
826 The symbol is in the text (code) section.
829 The symbol is undefined.
832 The symbol is a unique global symbol. This is a GNU extension to the
833 standard set of ELF symbol bindings. For such a symbol the dynamic linker
834 will make sure that in the entire process there is just one symbol with
835 this name and type in use.
839 The symbol is a weak object. When a weak defined symbol is linked with
840 a normal defined symbol, the normal defined symbol is used with no error.
841 When a weak undefined symbol is linked and the symbol is not defined,
842 the value of the weak symbol becomes zero with no error. On some
843 systems, uppercase indicates that a default value has been specified.
847 The symbol is a weak symbol that has not been specifically tagged as a
848 weak object symbol. When a weak defined symbol is linked with a normal
849 defined symbol, the normal defined symbol is used with no error.
850 When a weak undefined symbol is linked and the symbol is not defined,
851 the value of the symbol is determined in a system-specific manner without
852 error. On some systems, uppercase indicates that a default value has been
856 The symbol is a stabs symbol in an a.out object file. In this case, the
857 next values printed are the stabs other field, the stabs desc field, and
858 the stab type. Stabs symbols are used to hold debugging information.
861 The symbol type is unknown, or object file format specific.
870 @c man begin OPTIONS nm
871 The long and short forms of options, shown here as alternatives, are
877 @itemx --print-file-name
878 @cindex input file name
880 @cindex source file name
881 Precede each symbol by the name of the input file (or archive member)
882 in which it was found, rather than identifying the input file once only,
883 before all of its symbols.
887 @cindex debugging symbols
888 Display all symbols, even debugger-only symbols; normally these are not
892 @cindex @command{nm} format
893 @cindex @command{nm} compatibility
894 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
897 @itemx --demangle[=@var{style}]
898 @cindex demangling in nm
899 Decode (@dfn{demangle}) low-level symbol names into user-level names.
900 Besides removing any initial underscore prepended by the system, this
901 makes C++ function names readable. Different compilers have different
902 mangling styles. The optional demangling style argument can be used to
903 choose an appropriate demangling style for your compiler. @xref{c++filt},
904 for more information on demangling.
907 Do not demangle low-level symbol names. This is the default.
911 @cindex dynamic symbols
912 Display the dynamic symbols rather than the normal symbols. This is
913 only meaningful for dynamic objects, such as certain types of shared
916 @item -f @var{format}
917 @itemx --format=@var{format}
918 @cindex @command{nm} format
919 @cindex @command{nm} compatibility
920 Use the output format @var{format}, which can be @code{bsd},
921 @code{sysv}, or @code{posix}. The default is @code{bsd}.
922 Only the first character of @var{format} is significant; it can be
923 either upper or lower case.
927 @cindex external symbols
928 Display only external symbols.
932 Show a summary of the options to @command{nm} and exit.
935 @itemx --line-numbers
936 @cindex symbol line numbers
937 For each symbol, use debugging information to try to find a filename and
938 line number. For a defined symbol, look for the line number of the
939 address of the symbol. For an undefined symbol, look for the line
940 number of a relocation entry which refers to the symbol. If line number
941 information can be found, print it after the other symbol information.
945 @itemx --numeric-sort
946 Sort symbols numerically by their addresses, rather than alphabetically
951 @cindex sorting symbols
952 Do not bother to sort the symbols in any order; print them in the order
957 Use the POSIX.2 standard output format instead of the default format.
958 Equivalent to @samp{-f posix}.
961 @itemx --reverse-sort
962 Reverse the order of the sort (whether numeric or alphabetic); let the
967 Print both value and size of defined symbols for the @code{bsd} output style.
968 This option has no effect for object formats that do not record symbol
969 sizes, unless @samp{--size-sort} is also used in which case a
970 calculated size is displayed.
974 @cindex symbol index, listing
975 When listing symbols from archive members, include the index: a mapping
976 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
977 contain definitions for which names.
980 @itemx --radix=@var{radix}
981 Use @var{radix} as the radix for printing the symbol values. It must be
982 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
985 @itemx --undefined-only
986 @cindex external symbols
987 @cindex undefined symbols
988 Display only undefined symbols (those external to each object file).
992 Show the version number of @command{nm} and exit.
995 This option is ignored for compatibility with the AIX version of
996 @command{nm}. It takes one parameter which must be the string
997 @option{32_64}. The default mode of AIX @command{nm} corresponds
998 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1000 @item --defined-only
1001 @cindex external symbols
1002 @cindex undefined symbols
1003 Display only defined symbols for each object file.
1005 @item --plugin @var{name}
1007 Load the plugin called @var{name} to add support for extra target
1008 types. This option is only available if the toolchain has been built
1009 with plugin support enabled.
1012 Sort symbols by size. The size is computed as the difference between
1013 the value of the symbol and the value of the symbol with the next higher
1014 value. If the @code{bsd} output format is used the size of the symbol
1015 is printed, rather than the value, and @samp{-S} must be used in order
1016 both size and value to be printed.
1018 @item --special-syms
1019 Display symbols which have a target-specific special meaning. These
1020 symbols are usually used by the target for some special processing and
1021 are not normally helpful when included included in the normal symbol
1022 lists. For example for ARM targets this option would skip the mapping
1023 symbols used to mark transitions between ARM code, THUMB code and
1027 Include synthetic symbols in the output. These are special symbols
1028 created by the linker for various purposes. They are not shown by
1029 default since they are not part of the binary's original source code.
1031 @item --target=@var{bfdname}
1032 @cindex object code format
1033 Specify an object code format other than your system's default format.
1034 @xref{Target Selection}, for more information.
1041 @c man begin SEEALSO nm
1042 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1049 @c man title objcopy copy and translate object files
1052 @c man begin SYNOPSIS objcopy
1053 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1054 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1055 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1056 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1057 [@option{-S}|@option{--strip-all}]
1058 [@option{-g}|@option{--strip-debug}]
1059 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1060 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1061 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1062 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1063 [@option{--localize-hidden}]
1064 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1065 [@option{--globalize-symbol=}@var{symbolname}]
1066 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1067 [@option{-w}|@option{--wildcard}]
1068 [@option{-x}|@option{--discard-all}]
1069 [@option{-X}|@option{--discard-locals}]
1070 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1071 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1072 [@option{--interleave-width=}@var{width}]
1073 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1074 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1075 [@option{-p}|@option{--preserve-dates}]
1076 [@option{-D}|@option{--enable-deterministic-archives}]
1077 [@option{-U}|@option{--disable-deterministic-archives}]
1078 [@option{--debugging}]
1079 [@option{--gap-fill=}@var{val}]
1080 [@option{--pad-to=}@var{address}]
1081 [@option{--set-start=}@var{val}]
1082 [@option{--adjust-start=}@var{incr}]
1083 [@option{--change-addresses=}@var{incr}]
1084 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1085 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1086 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1087 [@option{--change-warnings}] [@option{--no-change-warnings}]
1088 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1089 [@option{--add-section} @var{sectionname}=@var{filename}]
1090 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1091 [@option{--long-section-names} @{enable,disable,keep@}]
1092 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1093 [@option{--reverse-bytes=}@var{num}]
1094 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1095 [@option{--redefine-sym} @var{old}=@var{new}]
1096 [@option{--redefine-syms=}@var{filename}]
1098 [@option{--keep-symbols=}@var{filename}]
1099 [@option{--strip-symbols=}@var{filename}]
1100 [@option{--strip-unneeded-symbols=}@var{filename}]
1101 [@option{--keep-global-symbols=}@var{filename}]
1102 [@option{--localize-symbols=}@var{filename}]
1103 [@option{--globalize-symbols=}@var{filename}]
1104 [@option{--weaken-symbols=}@var{filename}]
1105 [@option{--alt-machine-code=}@var{index}]
1106 [@option{--prefix-symbols=}@var{string}]
1107 [@option{--prefix-sections=}@var{string}]
1108 [@option{--prefix-alloc-sections=}@var{string}]
1109 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1110 [@option{--keep-file-symbols}]
1111 [@option{--only-keep-debug}]
1112 [@option{--strip-dwo}]
1113 [@option{--extract-dwo}]
1114 [@option{--extract-symbol}]
1115 [@option{--writable-text}]
1116 [@option{--readonly-text}]
1119 [@option{--file-alignment=}@var{num}]
1120 [@option{--heap=}@var{size}]
1121 [@option{--image-base=}@var{address}]
1122 [@option{--section-alignment=}@var{num}]
1123 [@option{--stack=}@var{size}]
1124 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1125 [@option{--compress-debug-sections}]
1126 [@option{--decompress-debug-sections}]
1127 [@option{--dwarf-depth=@var{n}}]
1128 [@option{--dwarf-start=@var{n}}]
1129 [@option{-v}|@option{--verbose}]
1130 [@option{-V}|@option{--version}]
1131 [@option{--help}] [@option{--info}]
1132 @var{infile} [@var{outfile}]
1136 @c man begin DESCRIPTION objcopy
1137 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1138 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1139 read and write the object files. It can write the destination object
1140 file in a format different from that of the source object file. The
1141 exact behavior of @command{objcopy} is controlled by command-line options.
1142 Note that @command{objcopy} should be able to copy a fully linked file
1143 between any two formats. However, copying a relocatable object file
1144 between any two formats may not work as expected.
1146 @command{objcopy} creates temporary files to do its translations and
1147 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1148 translation work; it has access to all the formats described in @sc{bfd}
1149 and thus is able to recognize most formats without being told
1150 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1152 @command{objcopy} can be used to generate S-records by using an output
1153 target of @samp{srec} (e.g., use @samp{-O srec}).
1155 @command{objcopy} can be used to generate a raw binary file by using an
1156 output target of @samp{binary} (e.g., use @option{-O binary}). When
1157 @command{objcopy} generates a raw binary file, it will essentially produce
1158 a memory dump of the contents of the input object file. All symbols and
1159 relocation information will be discarded. The memory dump will start at
1160 the load address of the lowest section copied into the output file.
1162 When generating an S-record or a raw binary file, it may be helpful to
1163 use @option{-S} to remove sections containing debugging information. In
1164 some cases @option{-R} will be useful to remove sections which contain
1165 information that is not needed by the binary file.
1167 Note---@command{objcopy} is not able to change the endianness of its input
1168 files. If the input format has an endianness (some formats do not),
1169 @command{objcopy} can only copy the inputs into file formats that have the
1170 same endianness or which have no endianness (e.g., @samp{srec}).
1171 (However, see the @option{--reverse-bytes} option.)
1175 @c man begin OPTIONS objcopy
1179 @itemx @var{outfile}
1180 The input and output files, respectively.
1181 If you do not specify @var{outfile}, @command{objcopy} creates a
1182 temporary file and destructively renames the result with
1183 the name of @var{infile}.
1185 @item -I @var{bfdname}
1186 @itemx --input-target=@var{bfdname}
1187 Consider the source file's object format to be @var{bfdname}, rather than
1188 attempting to deduce it. @xref{Target Selection}, for more information.
1190 @item -O @var{bfdname}
1191 @itemx --output-target=@var{bfdname}
1192 Write the output file using the object format @var{bfdname}.
1193 @xref{Target Selection}, for more information.
1195 @item -F @var{bfdname}
1196 @itemx --target=@var{bfdname}
1197 Use @var{bfdname} as the object format for both the input and the output
1198 file; i.e., simply transfer data from source to destination with no
1199 translation. @xref{Target Selection}, for more information.
1201 @item -B @var{bfdarch}
1202 @itemx --binary-architecture=@var{bfdarch}
1203 Useful when transforming a architecture-less input file into an object file.
1204 In this case the output architecture can be set to @var{bfdarch}. This
1205 option will be ignored if the input file has a known @var{bfdarch}. You
1206 can access this binary data inside a program by referencing the special
1207 symbols that are created by the conversion process. These symbols are
1208 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1209 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1210 an object file and then access it in your code using these symbols.
1212 @item -j @var{sectionpattern}
1213 @itemx --only-section=@var{sectionpattern}
1214 Copy only the indicated sections from the input file to the output file.
1215 This option may be given more than once. Note that using this option
1216 inappropriately may make the output file unusable. Wildcard
1217 characters are accepted in @var{sectionpattern}.
1219 @item -R @var{sectionpattern}
1220 @itemx --remove-section=@var{sectionpattern}
1221 Remove any section matching @var{sectionpattern} from the output file.
1222 This option may be given more than once. Note that using this option
1223 inappropriately may make the output file unusable. Wildcard
1224 characters are accepted in @var{sectionpattern}. Using both the
1225 @option{-j} and @option{-R} options together results in undefined
1230 Do not copy relocation and symbol information from the source file.
1233 @itemx --strip-debug
1234 Do not copy debugging symbols or sections from the source file.
1236 @item --strip-unneeded
1237 Strip all symbols that are not needed for relocation processing.
1239 @item -K @var{symbolname}
1240 @itemx --keep-symbol=@var{symbolname}
1241 When stripping symbols, keep symbol @var{symbolname} even if it would
1242 normally be stripped. This option may be given more than once.
1244 @item -N @var{symbolname}
1245 @itemx --strip-symbol=@var{symbolname}
1246 Do not copy symbol @var{symbolname} from the source file. This option
1247 may be given more than once.
1249 @item --strip-unneeded-symbol=@var{symbolname}
1250 Do not copy symbol @var{symbolname} from the source file unless it is needed
1251 by a relocation. This option may be given more than once.
1253 @item -G @var{symbolname}
1254 @itemx --keep-global-symbol=@var{symbolname}
1255 Keep only symbol @var{symbolname} global. Make all other symbols local
1256 to the file, so that they are not visible externally. This option may
1257 be given more than once.
1259 @item --localize-hidden
1260 In an ELF object, mark all symbols that have hidden or internal visibility
1261 as local. This option applies on top of symbol-specific localization options
1262 such as @option{-L}.
1264 @item -L @var{symbolname}
1265 @itemx --localize-symbol=@var{symbolname}
1266 Make symbol @var{symbolname} local to the file, so that it is not
1267 visible externally. This option may be given more than once.
1269 @item -W @var{symbolname}
1270 @itemx --weaken-symbol=@var{symbolname}
1271 Make symbol @var{symbolname} weak. This option may be given more than once.
1273 @item --globalize-symbol=@var{symbolname}
1274 Give symbol @var{symbolname} global scoping so that it is visible
1275 outside of the file in which it is defined. This option may be given
1280 Permit regular expressions in @var{symbolname}s used in other command
1281 line options. The question mark (?), asterisk (*), backslash (\) and
1282 square brackets ([]) operators can be used anywhere in the symbol
1283 name. If the first character of the symbol name is the exclamation
1284 point (!) then the sense of the switch is reversed for that symbol.
1291 would cause objcopy to weaken all symbols that start with ``fo''
1292 except for the symbol ``foo''.
1295 @itemx --discard-all
1296 Do not copy non-global symbols from the source file.
1297 @c FIXME any reason to prefer "non-global" to "local" here?
1300 @itemx --discard-locals
1301 Do not copy compiler-generated local symbols.
1302 (These usually start with @samp{L} or @samp{.}.)
1305 @itemx --byte=@var{byte}
1306 If interleaving has been enabled via the @option{--interleave} option
1307 then start the range of bytes to keep at the @var{byte}th byte.
1308 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1309 @var{breadth} is the value given by the @option{--interleave} option.
1311 @item -i [@var{breadth}]
1312 @itemx --interleave[=@var{breadth}]
1313 Only copy a range out of every @var{breadth} bytes. (Header data is
1314 not affected). Select which byte in the range begins the copy with
1315 the @option{--byte} option. Select the width of the range with the
1316 @option{--interleave-width} option.
1318 This option is useful for creating files to program @sc{rom}. It is
1319 typically used with an @code{srec} output target. Note that
1320 @command{objcopy} will complain if you do not specify the
1321 @option{--byte} option as well.
1323 The default interleave breadth is 4, so with @option{--byte} set to 0,
1324 @command{objcopy} would copy the first byte out of every four bytes
1325 from the input to the output.
1327 @item --interleave-width=@var{width}
1328 When used with the @option{--interleave} option, copy @var{width}
1329 bytes at a time. The start of the range of bytes to be copied is set
1330 by the @option{--byte} option, and the extent of the range is set with
1331 the @option{--interleave} option.
1333 The default value for this option is 1. The value of @var{width} plus
1334 the @var{byte} value set by the @option{--byte} option must not exceed
1335 the interleave breadth set by the @option{--interleave} option.
1337 This option can be used to create images for two 16-bit flashes interleaved
1338 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1339 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1340 commands. If the input was '12345678' then the outputs would be
1341 '1256' and '3478' respectively.
1344 @itemx --preserve-dates
1345 Set the access and modification dates of the output file to be the same
1346 as those of the input file.
1349 @itemx --enable-deterministic-archives
1350 @cindex deterministic archives
1351 @kindex --enable-deterministic-archives
1352 Operate in @emph{deterministic} mode. When copying archive members
1353 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1354 and use consistent file modes for all files.
1356 If @file{binutils} was configured with
1357 @option{--enable-deterministic-archives}, then this mode is on by default.
1358 It can be disabled with the @samp{-U} option, below.
1361 @itemx --disable-deterministic-archives
1362 @cindex deterministic archives
1363 @kindex --enable-deterministic-archives
1364 Do @emph{not} operate in @emph{deterministic} mode. This is the
1365 inverse of the @option{-D} option, above: when copying archive members
1366 and writing the archive index, use their actual UID, GID, timestamp,
1367 and file mode values.
1369 This is the default unless @file{binutils} was configured with
1370 @option{--enable-deterministic-archives}.
1373 Convert debugging information, if possible. This is not the default
1374 because only certain debugging formats are supported, and the
1375 conversion process can be time consuming.
1377 @item --gap-fill @var{val}
1378 Fill gaps between sections with @var{val}. This operation applies to
1379 the @emph{load address} (LMA) of the sections. It is done by increasing
1380 the size of the section with the lower address, and filling in the extra
1381 space created with @var{val}.
1383 @item --pad-to @var{address}
1384 Pad the output file up to the load address @var{address}. This is
1385 done by increasing the size of the last section. The extra space is
1386 filled in with the value specified by @option{--gap-fill} (default zero).
1388 @item --set-start @var{val}
1389 Set the start address of the new file to @var{val}. Not all object file
1390 formats support setting the start address.
1392 @item --change-start @var{incr}
1393 @itemx --adjust-start @var{incr}
1394 @cindex changing start address
1395 Change the start address by adding @var{incr}. Not all object file
1396 formats support setting the start address.
1398 @item --change-addresses @var{incr}
1399 @itemx --adjust-vma @var{incr}
1400 @cindex changing object addresses
1401 Change the VMA and LMA addresses of all sections, as well as the start
1402 address, by adding @var{incr}. Some object file formats do not permit
1403 section addresses to be changed arbitrarily. Note that this does not
1404 relocate the sections; if the program expects sections to be loaded at a
1405 certain address, and this option is used to change the sections such
1406 that they are loaded at a different address, the program may fail.
1408 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1409 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1410 @cindex changing section address
1411 Set or change both the VMA address and the LMA address of any section
1412 matching @var{sectionpattern}. If @samp{=} is used, the section
1413 address is set to @var{val}. Otherwise, @var{val} is added to or
1414 subtracted from the section address. See the comments under
1415 @option{--change-addresses}, above. If @var{sectionpattern} does not
1416 match any sections in the input file, a warning will be issued, unless
1417 @option{--no-change-warnings} is used.
1419 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1420 @cindex changing section LMA
1421 Set or change the LMA address of any sections matching
1422 @var{sectionpattern}. The LMA address is the address where the
1423 section will be loaded into memory at program load time. Normally
1424 this is the same as the VMA address, which is the address of the
1425 section at program run time, but on some systems, especially those
1426 where a program is held in ROM, the two can be different. If @samp{=}
1427 is used, the section address is set to @var{val}. Otherwise,
1428 @var{val} is added to or subtracted from the section address. See the
1429 comments under @option{--change-addresses}, above. If
1430 @var{sectionpattern} does not match any sections in the input file, a
1431 warning will be issued, unless @option{--no-change-warnings} is used.
1433 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1434 @cindex changing section VMA
1435 Set or change the VMA address of any section matching
1436 @var{sectionpattern}. The VMA address is the address where the
1437 section will be located once the program has started executing.
1438 Normally this is the same as the LMA address, which is the address
1439 where the section will be loaded into memory, but on some systems,
1440 especially those where a program is held in ROM, the two can be
1441 different. If @samp{=} is used, the section address is set to
1442 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1443 section address. See the comments under @option{--change-addresses},
1444 above. If @var{sectionpattern} does not match any sections in the
1445 input file, a warning will be issued, unless
1446 @option{--no-change-warnings} is used.
1448 @item --change-warnings
1449 @itemx --adjust-warnings
1450 If @option{--change-section-address} or @option{--change-section-lma} or
1451 @option{--change-section-vma} is used, and the section pattern does not
1452 match any sections, issue a warning. This is the default.
1454 @item --no-change-warnings
1455 @itemx --no-adjust-warnings
1456 Do not issue a warning if @option{--change-section-address} or
1457 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1458 if the section pattern does not match any sections.
1460 @item --set-section-flags @var{sectionpattern}=@var{flags}
1461 Set the flags for any sections matching @var{sectionpattern}. The
1462 @var{flags} argument is a comma separated string of flag names. The
1463 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1464 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1465 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1466 for a section which does not have contents, but it is not meaningful
1467 to clear the @samp{contents} flag of a section which does have
1468 contents--just remove the section instead. Not all flags are
1469 meaningful for all object file formats.
1471 @item --add-section @var{sectionname}=@var{filename}
1472 Add a new section named @var{sectionname} while copying the file. The
1473 contents of the new section are taken from the file @var{filename}. The
1474 size of the section will be the size of the file. This option only
1475 works on file formats which can support sections with arbitrary names.
1477 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1478 Rename a section from @var{oldname} to @var{newname}, optionally
1479 changing the section's flags to @var{flags} in the process. This has
1480 the advantage over usng a linker script to perform the rename in that
1481 the output stays as an object file and does not become a linked
1484 This option is particularly helpful when the input format is binary,
1485 since this will always create a section called .data. If for example,
1486 you wanted instead to create a section called .rodata containing binary
1487 data you could use the following command line to achieve it:
1490 objcopy -I binary -O <output_format> -B <architecture> \
1491 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1492 <input_binary_file> <output_object_file>
1495 @item --long-section-names @{enable,disable,keep@}
1496 Controls the handling of long section names when processing @code{COFF}
1497 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1498 is to preserve long section names if any are present in the input file.
1499 The @samp{enable} and @samp{disable} options forcibly enable or disable
1500 the use of long section names in the output object; when @samp{disable}
1501 is in effect, any long section names in the input object will be truncated.
1502 The @samp{enable} option will only emit long section names if any are
1503 present in the inputs; this is mostly the same as @samp{keep}, but it
1504 is left undefined whether the @samp{enable} option might force the
1505 creation of an empty string table in the output file.
1507 @item --change-leading-char
1508 Some object file formats use special characters at the start of
1509 symbols. The most common such character is underscore, which compilers
1510 often add before every symbol. This option tells @command{objcopy} to
1511 change the leading character of every symbol when it converts between
1512 object file formats. If the object file formats use the same leading
1513 character, this option has no effect. Otherwise, it will add a
1514 character, or remove a character, or change a character, as
1517 @item --remove-leading-char
1518 If the first character of a global symbol is a special symbol leading
1519 character used by the object file format, remove the character. The
1520 most common symbol leading character is underscore. This option will
1521 remove a leading underscore from all global symbols. This can be useful
1522 if you want to link together objects of different file formats with
1523 different conventions for symbol names. This is different from
1524 @option{--change-leading-char} because it always changes the symbol name
1525 when appropriate, regardless of the object file format of the output
1528 @item --reverse-bytes=@var{num}
1529 Reverse the bytes in a section with output contents. A section length must
1530 be evenly divisible by the value given in order for the swap to be able to
1531 take place. Reversing takes place before the interleaving is performed.
1533 This option is used typically in generating ROM images for problematic
1534 target systems. For example, on some target boards, the 32-bit words
1535 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1536 regardless of the CPU byte order. Depending on the programming model, the
1537 endianness of the ROM may need to be modified.
1539 Consider a simple file with a section containing the following eight
1540 bytes: @code{12345678}.
1542 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1543 output file would be ordered @code{21436587}.
1545 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1546 output file would be ordered @code{43218765}.
1548 By using @samp{--reverse-bytes=2} for the above example, followed by
1549 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1550 output file would be ordered @code{34127856}.
1552 @item --srec-len=@var{ival}
1553 Meaningful only for srec output. Set the maximum length of the Srecords
1554 being produced to @var{ival}. This length covers both address, data and
1557 @item --srec-forceS3
1558 Meaningful only for srec output. Avoid generation of S1/S2 records,
1559 creating S3-only record format.
1561 @item --redefine-sym @var{old}=@var{new}
1562 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1563 when one is trying link two things together for which you have no
1564 source, and there are name collisions.
1566 @item --redefine-syms=@var{filename}
1567 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1568 listed in the file @var{filename}. @var{filename} is simply a flat file,
1569 with one symbol pair per line. Line comments may be introduced by the hash
1570 character. This option may be given more than once.
1573 Change all global symbols in the file to be weak. This can be useful
1574 when building an object which will be linked against other objects using
1575 the @option{-R} option to the linker. This option is only effective when
1576 using an object file format which supports weak symbols.
1578 @item --keep-symbols=@var{filename}
1579 Apply @option{--keep-symbol} option to each symbol listed in the file
1580 @var{filename}. @var{filename} is simply a flat file, with one symbol
1581 name per line. Line comments may be introduced by the hash character.
1582 This option may be given more than once.
1584 @item --strip-symbols=@var{filename}
1585 Apply @option{--strip-symbol} option to each symbol listed in the file
1586 @var{filename}. @var{filename} is simply a flat file, with one symbol
1587 name per line. Line comments may be introduced by the hash character.
1588 This option may be given more than once.
1590 @item --strip-unneeded-symbols=@var{filename}
1591 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1592 the file @var{filename}. @var{filename} is simply a flat file, with one
1593 symbol name per line. Line comments may be introduced by the hash
1594 character. This option may be given more than once.
1596 @item --keep-global-symbols=@var{filename}
1597 Apply @option{--keep-global-symbol} option to each symbol listed in the
1598 file @var{filename}. @var{filename} is simply a flat file, with one
1599 symbol name per line. Line comments may be introduced by the hash
1600 character. This option may be given more than once.
1602 @item --localize-symbols=@var{filename}
1603 Apply @option{--localize-symbol} option to each symbol listed in the file
1604 @var{filename}. @var{filename} is simply a flat file, with one symbol
1605 name per line. Line comments may be introduced by the hash character.
1606 This option may be given more than once.
1608 @item --globalize-symbols=@var{filename}
1609 Apply @option{--globalize-symbol} option to each symbol listed in the file
1610 @var{filename}. @var{filename} is simply a flat file, with one symbol
1611 name per line. Line comments may be introduced by the hash character.
1612 This option may be given more than once.
1614 @item --weaken-symbols=@var{filename}
1615 Apply @option{--weaken-symbol} option to each symbol listed in the file
1616 @var{filename}. @var{filename} is simply a flat file, with one symbol
1617 name per line. Line comments may be introduced by the hash character.
1618 This option may be given more than once.
1620 @item --alt-machine-code=@var{index}
1621 If the output architecture has alternate machine codes, use the
1622 @var{index}th code instead of the default one. This is useful in case
1623 a machine is assigned an official code and the tool-chain adopts the
1624 new code, but other applications still depend on the original code
1625 being used. For ELF based architectures if the @var{index}
1626 alternative does not exist then the value is treated as an absolute
1627 number to be stored in the e_machine field of the ELF header.
1629 @item --writable-text
1630 Mark the output text as writable. This option isn't meaningful for all
1631 object file formats.
1633 @item --readonly-text
1634 Make the output text write protected. This option isn't meaningful for all
1635 object file formats.
1638 Mark the output file as demand paged. This option isn't meaningful for all
1639 object file formats.
1642 Mark the output file as impure. This option isn't meaningful for all
1643 object file formats.
1645 @item --prefix-symbols=@var{string}
1646 Prefix all symbols in the output file with @var{string}.
1648 @item --prefix-sections=@var{string}
1649 Prefix all section names in the output file with @var{string}.
1651 @item --prefix-alloc-sections=@var{string}
1652 Prefix all the names of all allocated sections in the output file with
1655 @item --add-gnu-debuglink=@var{path-to-file}
1656 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1657 and adds it to the output file.
1659 @item --keep-file-symbols
1660 When stripping a file, perhaps with @option{--strip-debug} or
1661 @option{--strip-unneeded}, retain any symbols specifying source file names,
1662 which would otherwise get stripped.
1664 @item --only-keep-debug
1665 Strip a file, removing contents of any sections that would not be
1666 stripped by @option{--strip-debug} and leaving the debugging sections
1667 intact. In ELF files, this preserves all note sections in the output.
1669 The intention is that this option will be used in conjunction with
1670 @option{--add-gnu-debuglink} to create a two part executable. One a
1671 stripped binary which will occupy less space in RAM and in a
1672 distribution and the second a debugging information file which is only
1673 needed if debugging abilities are required. The suggested procedure
1674 to create these files is as follows:
1677 @item Link the executable as normal. Assuming that is is called
1679 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1680 create a file containing the debugging info.
1681 @item Run @code{objcopy --strip-debug foo} to create a
1682 stripped executable.
1683 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1684 to add a link to the debugging info into the stripped executable.
1687 Note---the choice of @code{.dbg} as an extension for the debug info
1688 file is arbitrary. Also the @code{--only-keep-debug} step is
1689 optional. You could instead do this:
1692 @item Link the executable as normal.
1693 @item Copy @code{foo} to @code{foo.full}
1694 @item Run @code{objcopy --strip-debug foo}
1695 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1698 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1699 full executable. It does not have to be a file created by the
1700 @option{--only-keep-debug} switch.
1702 Note---this switch is only intended for use on fully linked files. It
1703 does not make sense to use it on object files where the debugging
1704 information may be incomplete. Besides the gnu_debuglink feature
1705 currently only supports the presence of one filename containing
1706 debugging information, not multiple filenames on a one-per-object-file
1710 Remove the contents of all DWARF .dwo sections, leaving the
1711 remaining debugging sections and all symbols intact.
1712 This option is intended for use by the compiler as part of
1713 the @option{-gsplit-dwarf} option, which splits debug information
1714 between the .o file and a separate .dwo file. The compiler
1715 generates all debug information in the same file, then uses
1716 the @option{--extract-dwo} option to copy the .dwo sections to
1717 the .dwo file, then the @option{--strip-dwo} option to remove
1718 those sections from the original .o file.
1721 Extract the contents of all DWARF .dwo sections. See the
1722 @option{--strip-dwo} option for more information.
1724 @item --file-alignment @var{num}
1725 Specify the file alignment. Sections in the file will always begin at
1726 file offsets which are multiples of this number. This defaults to
1728 [This option is specific to PE targets.]
1730 @item --heap @var{reserve}
1731 @itemx --heap @var{reserve},@var{commit}
1732 Specify the number of bytes of memory to reserve (and optionally commit)
1733 to be used as heap for this program.
1734 [This option is specific to PE targets.]
1736 @item --image-base @var{value}
1737 Use @var{value} as the base address of your program or dll. This is
1738 the lowest memory location that will be used when your program or dll
1739 is loaded. To reduce the need to relocate and improve performance of
1740 your dlls, each should have a unique base address and not overlap any
1741 other dlls. The default is 0x400000 for executables, and 0x10000000
1743 [This option is specific to PE targets.]
1745 @item --section-alignment @var{num}
1746 Sets the section alignment. Sections in memory will always begin at
1747 addresses which are a multiple of this number. Defaults to 0x1000.
1748 [This option is specific to PE targets.]
1750 @item --stack @var{reserve}
1751 @itemx --stack @var{reserve},@var{commit}
1752 Specify the number of bytes of memory to reserve (and optionally commit)
1753 to be used as stack for this program.
1754 [This option is specific to PE targets.]
1756 @item --subsystem @var{which}
1757 @itemx --subsystem @var{which}:@var{major}
1758 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1759 Specifies the subsystem under which your program will execute. The
1760 legal values for @var{which} are @code{native}, @code{windows},
1761 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1762 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1763 the subsystem version also. Numeric values are also accepted for
1765 [This option is specific to PE targets.]
1767 @item --extract-symbol
1768 Keep the file's section flags and symbols but remove all section data.
1769 Specifically, the option:
1772 @item removes the contents of all sections;
1773 @item sets the size of every section to zero; and
1774 @item sets the file's start address to zero.
1777 This option is used to build a @file{.sym} file for a VxWorks kernel.
1778 It can also be a useful way of reducing the size of a @option{--just-symbols}
1781 @item --compress-debug-sections
1782 Compress DWARF debug sections using zlib.
1784 @item --decompress-debug-sections
1785 Decompress DWARF debug sections using zlib.
1789 Show the version number of @command{objcopy}.
1793 Verbose output: list all object files modified. In the case of
1794 archives, @samp{objcopy -V} lists all members of the archive.
1797 Show a summary of the options to @command{objcopy}.
1800 Display a list showing all architectures and object formats available.
1806 @c man begin SEEALSO objcopy
1807 ld(1), objdump(1), and the Info entries for @file{binutils}.
1814 @cindex object file information
1817 @c man title objdump display information from object files.
1820 @c man begin SYNOPSIS objdump
1821 objdump [@option{-a}|@option{--archive-headers}]
1822 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1823 [@option{-C}|@option{--demangle}[=@var{style}] ]
1824 [@option{-d}|@option{--disassemble}]
1825 [@option{-D}|@option{--disassemble-all}]
1826 [@option{-z}|@option{--disassemble-zeroes}]
1827 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1828 [@option{-f}|@option{--file-headers}]
1829 [@option{-F}|@option{--file-offsets}]
1830 [@option{--file-start-context}]
1831 [@option{-g}|@option{--debugging}]
1832 [@option{-e}|@option{--debugging-tags}]
1833 [@option{-h}|@option{--section-headers}|@option{--headers}]
1834 [@option{-i}|@option{--info}]
1835 [@option{-j} @var{section}|@option{--section=}@var{section}]
1836 [@option{-l}|@option{--line-numbers}]
1837 [@option{-S}|@option{--source}]
1838 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1839 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1840 [@option{-p}|@option{--private-headers}]
1841 [@option{-P} @var{options}|@option{--private=}@var{options}]
1842 [@option{-r}|@option{--reloc}]
1843 [@option{-R}|@option{--dynamic-reloc}]
1844 [@option{-s}|@option{--full-contents}]
1845 [@option{-W[lLiaprmfFsoRt]}|
1846 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
1847 [@option{-G}|@option{--stabs}]
1848 [@option{-t}|@option{--syms}]
1849 [@option{-T}|@option{--dynamic-syms}]
1850 [@option{-x}|@option{--all-headers}]
1851 [@option{-w}|@option{--wide}]
1852 [@option{--start-address=}@var{address}]
1853 [@option{--stop-address=}@var{address}]
1854 [@option{--prefix-addresses}]
1855 [@option{--[no-]show-raw-insn}]
1856 [@option{--adjust-vma=}@var{offset}]
1857 [@option{--special-syms}]
1858 [@option{--prefix=}@var{prefix}]
1859 [@option{--prefix-strip=}@var{level}]
1860 [@option{--insn-width=}@var{width}]
1861 [@option{-V}|@option{--version}]
1862 [@option{-H}|@option{--help}]
1863 @var{objfile}@dots{}
1867 @c man begin DESCRIPTION objdump
1869 @command{objdump} displays information about one or more object files.
1870 The options control what particular information to display. This
1871 information is mostly useful to programmers who are working on the
1872 compilation tools, as opposed to programmers who just want their
1873 program to compile and work.
1875 @var{objfile}@dots{} are the object files to be examined. When you
1876 specify archives, @command{objdump} shows information on each of the member
1881 @c man begin OPTIONS objdump
1883 The long and short forms of options, shown here as alternatives, are
1884 equivalent. At least one option from the list
1885 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1889 @itemx --archive-header
1890 @cindex archive headers
1891 If any of the @var{objfile} files are archives, display the archive
1892 header information (in a format similar to @samp{ls -l}). Besides the
1893 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1894 the object file format of each archive member.
1896 @item --adjust-vma=@var{offset}
1897 @cindex section addresses in objdump
1898 @cindex VMA in objdump
1899 When dumping information, first add @var{offset} to all the section
1900 addresses. This is useful if the section addresses do not correspond to
1901 the symbol table, which can happen when putting sections at particular
1902 addresses when using a format which can not represent section addresses,
1905 @item -b @var{bfdname}
1906 @itemx --target=@var{bfdname}
1907 @cindex object code format
1908 Specify that the object-code format for the object files is
1909 @var{bfdname}. This option may not be necessary; @var{objdump} can
1910 automatically recognize many formats.
1914 objdump -b oasys -m vax -h fu.o
1917 displays summary information from the section headers (@option{-h}) of
1918 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1919 file in the format produced by Oasys compilers. You can list the
1920 formats available with the @option{-i} option.
1921 @xref{Target Selection}, for more information.
1924 @itemx --demangle[=@var{style}]
1925 @cindex demangling in objdump
1926 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1927 Besides removing any initial underscore prepended by the system, this
1928 makes C++ function names readable. Different compilers have different
1929 mangling styles. The optional demangling style argument can be used to
1930 choose an appropriate demangling style for your compiler. @xref{c++filt},
1931 for more information on demangling.
1935 Display debugging information. This attempts to parse STABS and IEEE
1936 debugging format information stored in the file and print it out using
1937 a C like syntax. If neither of these formats are found this option
1938 falls back on the @option{-W} option to print any DWARF information in
1942 @itemx --debugging-tags
1943 Like @option{-g}, but the information is generated in a format compatible
1947 @itemx --disassemble
1948 @cindex disassembling object code
1949 @cindex machine instructions
1950 Display the assembler mnemonics for the machine instructions from
1951 @var{objfile}. This option only disassembles those sections which are
1952 expected to contain instructions.
1955 @itemx --disassemble-all
1956 Like @option{-d}, but disassemble the contents of all sections, not just
1957 those expected to contain instructions.
1959 If the target is an ARM architecture this switch also has the effect
1960 of forcing the disassembler to decode pieces of data found in code
1961 sections as if they were instructions.
1963 @item --prefix-addresses
1964 When disassembling, print the complete address on each line. This is
1965 the older disassembly format.
1969 @itemx --endian=@{big|little@}
1971 @cindex disassembly endianness
1972 Specify the endianness of the object files. This only affects
1973 disassembly. This can be useful when disassembling a file format which
1974 does not describe endianness information, such as S-records.
1977 @itemx --file-headers
1978 @cindex object file header
1979 Display summary information from the overall header of
1980 each of the @var{objfile} files.
1983 @itemx --file-offsets
1984 @cindex object file offsets
1985 When disassembling sections, whenever a symbol is displayed, also
1986 display the file offset of the region of data that is about to be
1987 dumped. If zeroes are being skipped, then when disassembly resumes,
1988 tell the user how many zeroes were skipped and the file offset of the
1989 location from where the disassembly resumes. When dumping sections,
1990 display the file offset of the location from where the dump starts.
1992 @item --file-start-context
1993 @cindex source code context
1994 Specify that when displaying interlisted source code/disassembly
1995 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1996 context to the start of the file.
1999 @itemx --section-headers
2001 @cindex section headers
2002 Display summary information from the section headers of the
2005 File segments may be relocated to nonstandard addresses, for example by
2006 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2007 @command{ld}. However, some object file formats, such as a.out, do not
2008 store the starting address of the file segments. In those situations,
2009 although @command{ld} relocates the sections correctly, using @samp{objdump
2010 -h} to list the file section headers cannot show the correct addresses.
2011 Instead, it shows the usual addresses, which are implicit for the
2016 Print a summary of the options to @command{objdump} and exit.
2020 @cindex architectures available
2021 @cindex object formats available
2022 Display a list showing all architectures and object formats available
2023 for specification with @option{-b} or @option{-m}.
2026 @itemx --section=@var{name}
2027 @cindex section information
2028 Display information only for section @var{name}.
2031 @itemx --line-numbers
2032 @cindex source filenames for object files
2033 Label the display (using debugging information) with the filename and
2034 source line numbers corresponding to the object code or relocs shown.
2035 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2037 @item -m @var{machine}
2038 @itemx --architecture=@var{machine}
2039 @cindex architecture
2040 @cindex disassembly architecture
2041 Specify the architecture to use when disassembling object files. This
2042 can be useful when disassembling object files which do not describe
2043 architecture information, such as S-records. You can list the available
2044 architectures with the @option{-i} option.
2046 If the target is an ARM architecture then this switch has an
2047 additional effect. It restricts the disassembly to only those
2048 instructions supported by the architecture specified by @var{machine}.
2049 If it is necessary to use this switch because the input file does not
2050 contain any architecture information, but it is also desired to
2051 disassemble all the instructions use @option{-marm}.
2053 @item -M @var{options}
2054 @itemx --disassembler-options=@var{options}
2055 Pass target specific information to the disassembler. Only supported on
2056 some targets. If it is necessary to specify more than one
2057 disassembler option then multiple @option{-M} options can be used or
2058 can be placed together into a comma separated list.
2060 If the target is an ARM architecture then this switch can be used to
2061 select which register name set is used during disassembler. Specifying
2062 @option{-M reg-names-std} (the default) will select the register names as
2063 used in ARM's instruction set documentation, but with register 13 called
2064 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2065 @option{-M reg-names-apcs} will select the name set used by the ARM
2066 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2067 just use @samp{r} followed by the register number.
2069 There are also two variants on the APCS register naming scheme enabled
2070 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2071 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2072 with the normal register names or the special register names).
2074 This option can also be used for ARM architectures to force the
2075 disassembler to interpret all instructions as Thumb instructions by
2076 using the switch @option{--disassembler-options=force-thumb}. This can be
2077 useful when attempting to disassemble thumb code produced by other
2080 For the x86, some of the options duplicate functions of the @option{-m}
2081 switch, but allow finer grained control. Multiple selections from the
2082 following may be specified as a comma separated string.
2083 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
2084 the given architecture. @option{intel} and @option{att} select between
2085 intel syntax mode and AT&T syntax mode.
2086 @option{intel-mnemonic} and @option{att-mnemonic} select between
2087 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
2088 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
2089 @option{addr64}, @option{addr32},
2090 @option{addr16}, @option{data32} and @option{data16} specify the default
2091 address size and operand size. These four options will be overridden if
2092 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
2093 option string. Lastly, @option{suffix}, when in AT&T mode,
2094 instructs the disassembler to print a mnemonic suffix even when the
2095 suffix could be inferred by the operands.
2097 For PowerPC, @option{booke} controls the disassembly of BookE
2098 instructions. @option{32} and @option{64} select PowerPC and
2099 PowerPC64 disassembly, respectively. @option{e300} selects
2100 disassembly for the e300 family. @option{440} selects disassembly for
2101 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2102 single instructions of the PPC750CL.
2104 For MIPS, this option controls the printing of instruction mnemonic
2105 names and register names in disassembled instructions. Multiple
2106 selections from the following may be specified as a comma separated
2107 string, and invalid options are ignored:
2111 Print the 'raw' instruction mnemonic instead of some pseudo
2112 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2113 'sll' instead of 'nop', etc.
2116 Disassemble the virtualization ASE instructions.
2118 @item gpr-names=@var{ABI}
2119 Print GPR (general-purpose register) names as appropriate
2120 for the specified ABI. By default, GPR names are selected according to
2121 the ABI of the binary being disassembled.
2123 @item fpr-names=@var{ABI}
2124 Print FPR (floating-point register) names as
2125 appropriate for the specified ABI. By default, FPR numbers are printed
2128 @item cp0-names=@var{ARCH}
2129 Print CP0 (system control coprocessor; coprocessor 0) register names
2130 as appropriate for the CPU or architecture specified by
2131 @var{ARCH}. By default, CP0 register names are selected according to
2132 the architecture and CPU of the binary being disassembled.
2134 @item hwr-names=@var{ARCH}
2135 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2136 as appropriate for the CPU or architecture specified by
2137 @var{ARCH}. By default, HWR names are selected according to
2138 the architecture and CPU of the binary being disassembled.
2140 @item reg-names=@var{ABI}
2141 Print GPR and FPR names as appropriate for the selected ABI.
2143 @item reg-names=@var{ARCH}
2144 Print CPU-specific register names (CP0 register and HWR names)
2145 as appropriate for the selected CPU or architecture.
2148 For any of the options listed above, @var{ABI} or
2149 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2150 rather than names, for the selected types of registers.
2151 You can list the available values of @var{ABI} and @var{ARCH} using
2152 the @option{--help} option.
2154 For VAX, you can specify function entry addresses with @option{-M
2155 entry:0xf00ba}. You can use this multiple times to properly
2156 disassemble VAX binary files that don't contain symbol tables (like
2157 ROM dumps). In these cases, the function entry mask would otherwise
2158 be decoded as VAX instructions, which would probably lead the rest
2159 of the function being wrongly disassembled.
2162 @itemx --private-headers
2163 Print information that is specific to the object file format. The exact
2164 information printed depends upon the object file format. For some
2165 object file formats, no additional information is printed.
2167 @item -P @var{options}
2168 @itemx --private=@var{options}
2169 Print information that is specific to the object file format. The
2170 argument @var{options} is a comma separated list that depends on the
2171 format (the lists of options is displayed with the help).
2173 For XCOFF, the available options are: @option{header}, @option{aout},
2174 @option{sections}, @option{syms}, @option{relocs}, @option{lineno},
2175 @option{loader}, @option{except}, @option{typchk}, @option{traceback},
2176 @option{toc} and @option{ldinfo}.
2180 @cindex relocation entries, in object file
2181 Print the relocation entries of the file. If used with @option{-d} or
2182 @option{-D}, the relocations are printed interspersed with the
2186 @itemx --dynamic-reloc
2187 @cindex dynamic relocation entries, in object file
2188 Print the dynamic relocation entries of the file. This is only
2189 meaningful for dynamic objects, such as certain types of shared
2190 libraries. As for @option{-r}, if used with @option{-d} or
2191 @option{-D}, the relocations are printed interspersed with the
2195 @itemx --full-contents
2196 @cindex sections, full contents
2197 @cindex object file sections
2198 Display the full contents of any sections requested. By default all
2199 non-empty sections are displayed.
2203 @cindex source disassembly
2204 @cindex disassembly, with source
2205 Display source code intermixed with disassembly, if possible. Implies
2208 @item --prefix=@var{prefix}
2209 @cindex Add prefix to absolute paths
2210 Specify @var{prefix} to add to the absolute paths when used with
2213 @item --prefix-strip=@var{level}
2214 @cindex Strip absolute paths
2215 Indicate how many initial directory names to strip off the hardwired
2216 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2218 @item --show-raw-insn
2219 When disassembling instructions, print the instruction in hex as well as
2220 in symbolic form. This is the default except when
2221 @option{--prefix-addresses} is used.
2223 @item --no-show-raw-insn
2224 When disassembling instructions, do not print the instruction bytes.
2225 This is the default when @option{--prefix-addresses} is used.
2227 @item --insn-width=@var{width}
2228 @cindex Instruction width
2229 Display @var{width} bytes on a single line when disassembling
2232 @item -W[lLiaprmfFsoRt]
2233 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
2235 @cindex debug symbols
2236 Displays the contents of the debug sections in the file, if any are
2237 present. If one of the optional letters or words follows the switch
2238 then only data found in those specific sections will be dumped.
2240 Note that there is no single letter option to display the content of
2241 trace sections or .gdb_index.
2243 Note: the output from the @option{=info} option can also be affected
2244 by the options @option{--dwarf-depth}, the @option{--dwarf-start} and
2245 the @option{--dwarf-check}.
2247 @item --dwarf-depth=@var{n}
2248 Limit the dump of the @code{.debug_info} section to @var{n} children.
2249 This is only useful with @option{--dwarf=info}. The default is
2250 to print all DIEs; the special value 0 for @var{n} will also have this
2253 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2254 levels will not be printed. The range for @var{n} is zero-based.
2256 @item --dwarf-start=@var{n}
2257 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2258 useful with @option{--dwarf=info}.
2260 If specified, this option will suppress printing of any header
2261 information and all DIEs before the DIE numbered @var{n}. Only
2262 siblings and children of the specified DIE will be printed.
2264 This can be used in conjunction with @option{--dwarf-depth}.
2267 Enable additional checks for consistency of Dwarf information.
2273 @cindex debug symbols
2274 @cindex ELF object file format
2275 Display the full contents of any sections requested. Display the
2276 contents of the .stab and .stab.index and .stab.excl sections from an
2277 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2278 @code{.stab} debugging symbol-table entries are carried in an ELF
2279 section. In most other file formats, debugging symbol-table entries are
2280 interleaved with linkage symbols, and are visible in the @option{--syms}
2283 @item --start-address=@var{address}
2284 @cindex start-address
2285 Start displaying data at the specified address. This affects the output
2286 of the @option{-d}, @option{-r} and @option{-s} options.
2288 @item --stop-address=@var{address}
2289 @cindex stop-address
2290 Stop displaying data at the specified address. This affects the output
2291 of the @option{-d}, @option{-r} and @option{-s} options.
2295 @cindex symbol table entries, printing
2296 Print the symbol table entries of the file.
2297 This is similar to the information provided by the @samp{nm} program,
2298 although the display format is different. The format of the output
2299 depends upon the format of the file being dumped, but there are two main
2300 types. One looks like this:
2303 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2304 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2307 where the number inside the square brackets is the number of the entry
2308 in the symbol table, the @var{sec} number is the section number, the
2309 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2310 symbol's type, the @var{scl} number is the symbol's storage class and
2311 the @var{nx} value is the number of auxilary entries associated with
2312 the symbol. The last two fields are the symbol's value and its name.
2314 The other common output format, usually seen with ELF based files,
2318 00000000 l d .bss 00000000 .bss
2319 00000000 g .text 00000000 fred
2322 Here the first number is the symbol's value (sometimes refered to as
2323 its address). The next field is actually a set of characters and
2324 spaces indicating the flag bits that are set on the symbol. These
2325 characters are described below. Next is the section with which the
2326 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2327 not connected with any section), or @emph{*UND*} if the section is
2328 referenced in the file being dumped, but not defined there.
2330 After the section name comes another field, a number, which for common
2331 symbols is the alignment and for other symbol is the size. Finally
2332 the symbol's name is displayed.
2334 The flag characters are divided into 7 groups as follows:
2340 The symbol is a local (l), global (g), unique global (u), neither
2341 global nor local (a space) or both global and local (!). A
2342 symbol can be neither local or global for a variety of reasons, e.g.,
2343 because it is used for debugging, but it is probably an indication of
2344 a bug if it is ever both local and global. Unique global symbols are
2345 a GNU extension to the standard set of ELF symbol bindings. For such
2346 a symbol the dynamic linker will make sure that in the entire process
2347 there is just one symbol with this name and type in use.
2350 The symbol is weak (w) or strong (a space).
2353 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2356 The symbol is a warning (W) or a normal symbol (a space). A warning
2357 symbol's name is a message to be displayed if the symbol following the
2358 warning symbol is ever referenced.
2362 The symbol is an indirect reference to another symbol (I), a function
2363 to be evaluated during reloc processing (i) or a normal symbol (a
2368 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2369 normal symbol (a space).
2374 The symbol is the name of a function (F) or a file (f) or an object
2375 (O) or just a normal symbol (a space).
2379 @itemx --dynamic-syms
2380 @cindex dynamic symbol table entries, printing
2381 Print the dynamic symbol table entries of the file. This is only
2382 meaningful for dynamic objects, such as certain types of shared
2383 libraries. This is similar to the information provided by the @samp{nm}
2384 program when given the @option{-D} (@option{--dynamic}) option.
2386 @item --special-syms
2387 When displaying symbols include those which the target considers to be
2388 special in some way and which would not normally be of interest to the
2393 Print the version number of @command{objdump} and exit.
2396 @itemx --all-headers
2397 @cindex all header information, object file
2398 @cindex header information, all
2399 Display all available header information, including the symbol table and
2400 relocation entries. Using @option{-x} is equivalent to specifying all of
2401 @option{-a -f -h -p -r -t}.
2405 @cindex wide output, printing
2406 Format some lines for output devices that have more than 80 columns.
2407 Also do not truncate symbol names when they are displayed.
2410 @itemx --disassemble-zeroes
2411 Normally the disassembly output will skip blocks of zeroes. This
2412 option directs the disassembler to disassemble those blocks, just like
2419 @c man begin SEEALSO objdump
2420 nm(1), readelf(1), and the Info entries for @file{binutils}.
2428 @cindex archive contents
2429 @cindex symbol index
2431 @c man title ranlib generate index to archive.
2434 @c man begin SYNOPSIS ranlib
2435 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2439 @c man begin DESCRIPTION ranlib
2441 @command{ranlib} generates an index to the contents of an archive and
2442 stores it in the archive. The index lists each symbol defined by a
2443 member of an archive that is a relocatable object file.
2445 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2447 An archive with such an index speeds up linking to the library and
2448 allows routines in the library to call each other without regard to
2449 their placement in the archive.
2451 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2452 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2457 @c man begin OPTIONS ranlib
2463 Show usage information for @command{ranlib}.
2468 Show the version number of @command{ranlib}.
2471 @cindex deterministic archives
2472 @kindex --enable-deterministic-archives
2473 Operate in @emph{deterministic} mode. The symbol map archive member's
2474 header will show zero for the UID, GID, and timestamp. When this
2475 option is used, multiple runs will produce identical output files.
2477 This is the default unless @file{binutils} was configured with
2478 @option{--enable-deterministic-archives}.
2481 Update the timestamp of the symbol map of an archive.
2484 @cindex deterministic archives
2485 @kindex --enable-deterministic-archives
2486 Do @emph{not} operate in @emph{deterministic} mode. This is the
2487 inverse of the @samp{-D} option, above: the archive index will get
2488 actual UID, GID, timestamp, and file mode values.
2490 This is the default unless @file{binutils} was configured with
2491 @option{--enable-deterministic-archives}.
2497 @c man begin SEEALSO ranlib
2498 ar(1), nm(1), and the Info entries for @file{binutils}.
2506 @cindex section sizes
2508 @c man title size list section sizes and total size.
2511 @c man begin SYNOPSIS size
2512 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2514 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2516 [@option{-t}|@option{--totals}]
2517 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2518 [@var{objfile}@dots{}]
2522 @c man begin DESCRIPTION size
2524 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2525 size---for each of the object or archive files @var{objfile} in its
2526 argument list. By default, one line of output is generated for each
2527 object file or each module in an archive.
2529 @var{objfile}@dots{} are the object files to be examined.
2530 If none are specified, the file @code{a.out} will be used.
2534 @c man begin OPTIONS size
2536 The command line options have the following meanings:
2541 @itemx --format=@var{compatibility}
2542 @cindex @command{size} display format
2543 Using one of these options, you can choose whether the output from @sc{gnu}
2544 @command{size} resembles output from System V @command{size} (using @option{-A},
2545 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2546 @option{--format=berkeley}). The default is the one-line format similar to
2548 @c Bonus for doc-source readers: you can also say --format=strange (or
2549 @c anything else that starts with 's') for sysv, and --format=boring (or
2550 @c anything else that starts with 'b') for Berkeley.
2552 Here is an example of the Berkeley (default) format of output from
2555 $ size --format=Berkeley ranlib size
2556 text data bss dec hex filename
2557 294880 81920 11592 388392 5ed28 ranlib
2558 294880 81920 11888 388688 5ee50 size
2562 This is the same data, but displayed closer to System V conventions:
2565 $ size --format=SysV ranlib size
2583 Show a summary of acceptable arguments and options.
2588 @itemx --radix=@var{number}
2589 @cindex @command{size} number format
2590 @cindex radix for section sizes
2591 Using one of these options, you can control whether the size of each
2592 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2593 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2594 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2595 values (8, 10, 16) are supported. The total size is always given in two
2596 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2597 octal and hexadecimal if you're using @option{-o}.
2600 Print total size of common symbols in each file. When using Berkeley
2601 format these are included in the bss size.
2605 Show totals of all objects listed (Berkeley format listing mode only).
2607 @item --target=@var{bfdname}
2608 @cindex object code format
2609 Specify that the object-code format for @var{objfile} is
2610 @var{bfdname}. This option may not be necessary; @command{size} can
2611 automatically recognize many formats.
2612 @xref{Target Selection}, for more information.
2616 Display the version number of @command{size}.
2622 @c man begin SEEALSO size
2623 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2630 @cindex listings strings
2631 @cindex printing strings
2632 @cindex strings, printing
2634 @c man title strings print the strings of printable characters in files.
2637 @c man begin SYNOPSIS strings
2638 strings [@option{-afovV}] [@option{-}@var{min-len}]
2639 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2640 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2641 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2642 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2643 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2644 [@option{--help}] [@option{--version}] @var{file}@dots{}
2648 @c man begin DESCRIPTION strings
2650 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2651 character sequences that are at least 4 characters long (or the number
2652 given with the options below) and are followed by an unprintable
2653 character. By default, it only prints the strings from the initialized
2654 and loaded sections of object files; for other types of files, it prints
2655 the strings from the whole file.
2657 @command{strings} is mainly useful for determining the contents of non-text
2662 @c man begin OPTIONS strings
2668 Do not scan only the initialized and loaded sections of object files;
2669 scan the whole files.
2672 @itemx --print-file-name
2673 Print the name of the file before each string.
2676 Print a summary of the program usage on the standard output and exit.
2678 @item -@var{min-len}
2679 @itemx -n @var{min-len}
2680 @itemx --bytes=@var{min-len}
2681 Print sequences of characters that are at least @var{min-len} characters
2682 long, instead of the default 4.
2685 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2686 act like @samp{-t d} instead. Since we can not be compatible with both
2687 ways, we simply chose one.
2689 @item -t @var{radix}
2690 @itemx --radix=@var{radix}
2691 Print the offset within the file before each string. The single
2692 character argument specifies the radix of the offset---@samp{o} for
2693 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2695 @item -e @var{encoding}
2696 @itemx --encoding=@var{encoding}
2697 Select the character encoding of the strings that are to be found.
2698 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2699 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2700 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2701 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2702 littleendian. Useful for finding wide character strings. (@samp{l}
2703 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2705 @item -T @var{bfdname}
2706 @itemx --target=@var{bfdname}
2707 @cindex object code format
2708 Specify an object code format other than your system's default format.
2709 @xref{Target Selection}, for more information.
2714 Print the program version number on the standard output and exit.
2720 @c man begin SEEALSO strings
2721 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2722 and the Info entries for @file{binutils}.
2730 @cindex removing symbols
2731 @cindex discarding symbols
2732 @cindex symbols, discarding
2734 @c man title strip Discard symbols from object files.
2737 @c man begin SYNOPSIS strip
2738 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2739 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2740 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2741 [@option{-s}|@option{--strip-all}]
2742 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2743 [@option{--strip-dwo}]
2744 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2745 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2746 [@option{-w}|@option{--wildcard}]
2747 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2748 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2749 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2750 [@option{-D}|@option{--enable-deterministic-archives}]
2751 [@option{-U}|@option{--disable-deterministic-archives}]
2752 [@option{--keep-file-symbols}]
2753 [@option{--only-keep-debug}]
2754 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2755 [@option{--help}] [@option{--info}]
2756 @var{objfile}@dots{}
2760 @c man begin DESCRIPTION strip
2762 @sc{gnu} @command{strip} discards all symbols from object files
2763 @var{objfile}. The list of object files may include archives.
2764 At least one object file must be given.
2766 @command{strip} modifies the files named in its argument,
2767 rather than writing modified copies under different names.
2771 @c man begin OPTIONS strip
2774 @item -F @var{bfdname}
2775 @itemx --target=@var{bfdname}
2776 Treat the original @var{objfile} as a file with the object
2777 code format @var{bfdname}, and rewrite it in the same format.
2778 @xref{Target Selection}, for more information.
2781 Show a summary of the options to @command{strip} and exit.
2784 Display a list showing all architectures and object formats available.
2786 @item -I @var{bfdname}
2787 @itemx --input-target=@var{bfdname}
2788 Treat the original @var{objfile} as a file with the object
2789 code format @var{bfdname}.
2790 @xref{Target Selection}, for more information.
2792 @item -O @var{bfdname}
2793 @itemx --output-target=@var{bfdname}
2794 Replace @var{objfile} with a file in the output format @var{bfdname}.
2795 @xref{Target Selection}, for more information.
2797 @item -R @var{sectionname}
2798 @itemx --remove-section=@var{sectionname}
2799 Remove any section named @var{sectionname} from the output file. This
2800 option may be given more than once. Note that using this option
2801 inappropriately may make the output file unusable. The wildcard
2802 character @samp{*} may be given at the end of @var{sectionname}. If
2803 so, then any section starting with @var{sectionname} will be removed.
2812 @itemx --strip-debug
2813 Remove debugging symbols only.
2816 Remove the contents of all DWARF .dwo sections, leaving the
2817 remaining debugging sections and all symbols intact.
2818 See the description of this option in the @command{objcopy} section
2819 for more information.
2821 @item --strip-unneeded
2822 Remove all symbols that are not needed for relocation processing.
2824 @item -K @var{symbolname}
2825 @itemx --keep-symbol=@var{symbolname}
2826 When stripping symbols, keep symbol @var{symbolname} even if it would
2827 normally be stripped. This option may be given more than once.
2829 @item -N @var{symbolname}
2830 @itemx --strip-symbol=@var{symbolname}
2831 Remove symbol @var{symbolname} from the source file. This option may be
2832 given more than once, and may be combined with strip options other than
2836 Put the stripped output in @var{file}, rather than replacing the
2837 existing file. When this argument is used, only one @var{objfile}
2838 argument may be specified.
2841 @itemx --preserve-dates
2842 Preserve the access and modification dates of the file.
2845 @itemx --enable-deterministic-archives
2846 @cindex deterministic archives
2847 @kindex --enable-deterministic-archives
2848 Operate in @emph{deterministic} mode. When copying archive members
2849 and writing the archive index, use zero for UIDs, GIDs, timestamps,
2850 and use consistent file modes for all files.
2852 If @file{binutils} was configured with
2853 @option{--enable-deterministic-archives}, then this mode is on by default.
2854 It can be disabled with the @samp{-U} option, below.
2857 @itemx --disable-deterministic-archives
2858 @cindex deterministic archives
2859 @kindex --enable-deterministic-archives
2860 Do @emph{not} operate in @emph{deterministic} mode. This is the
2861 inverse of the @option{-D} option, above: when copying archive members
2862 and writing the archive index, use their actual UID, GID, timestamp,
2863 and file mode values.
2865 This is the default unless @file{binutils} was configured with
2866 @option{--enable-deterministic-archives}.
2870 Permit regular expressions in @var{symbolname}s used in other command
2871 line options. The question mark (?), asterisk (*), backslash (\) and
2872 square brackets ([]) operators can be used anywhere in the symbol
2873 name. If the first character of the symbol name is the exclamation
2874 point (!) then the sense of the switch is reversed for that symbol.
2881 would cause strip to only keep symbols that start with the letters
2882 ``fo'', but to discard the symbol ``foo''.
2885 @itemx --discard-all
2886 Remove non-global symbols.
2889 @itemx --discard-locals
2890 Remove compiler-generated local symbols.
2891 (These usually start with @samp{L} or @samp{.}.)
2893 @item --keep-file-symbols
2894 When stripping a file, perhaps with @option{--strip-debug} or
2895 @option{--strip-unneeded}, retain any symbols specifying source file names,
2896 which would otherwise get stripped.
2898 @item --only-keep-debug
2899 Strip a file, removing contents of any sections that would not be
2900 stripped by @option{--strip-debug} and leaving the debugging sections
2901 intact. In ELF files, this preserves all note sections in the output.
2903 The intention is that this option will be used in conjunction with
2904 @option{--add-gnu-debuglink} to create a two part executable. One a
2905 stripped binary which will occupy less space in RAM and in a
2906 distribution and the second a debugging information file which is only
2907 needed if debugging abilities are required. The suggested procedure
2908 to create these files is as follows:
2911 @item Link the executable as normal. Assuming that is is called
2913 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2914 create a file containing the debugging info.
2915 @item Run @code{objcopy --strip-debug foo} to create a
2916 stripped executable.
2917 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2918 to add a link to the debugging info into the stripped executable.
2921 Note---the choice of @code{.dbg} as an extension for the debug info
2922 file is arbitrary. Also the @code{--only-keep-debug} step is
2923 optional. You could instead do this:
2926 @item Link the executable as normal.
2927 @item Copy @code{foo} to @code{foo.full}
2928 @item Run @code{strip --strip-debug foo}
2929 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2932 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2933 full executable. It does not have to be a file created by the
2934 @option{--only-keep-debug} switch.
2936 Note---this switch is only intended for use on fully linked files. It
2937 does not make sense to use it on object files where the debugging
2938 information may be incomplete. Besides the gnu_debuglink feature
2939 currently only supports the presence of one filename containing
2940 debugging information, not multiple filenames on a one-per-object-file
2945 Show the version number for @command{strip}.
2949 Verbose output: list all object files modified. In the case of
2950 archives, @samp{strip -v} lists all members of the archive.
2956 @c man begin SEEALSO strip
2957 the Info entries for @file{binutils}.
2961 @node c++filt, addr2line, strip, Top
2965 @cindex demangling C++ symbols
2967 @c man title cxxfilt Demangle C++ and Java symbols.
2970 @c man begin SYNOPSIS cxxfilt
2971 c++filt [@option{-_}|@option{--strip-underscore}]
2972 [@option{-n}|@option{--no-strip-underscore}]
2973 [@option{-p}|@option{--no-params}]
2974 [@option{-t}|@option{--types}]
2975 [@option{-i}|@option{--no-verbose}]
2976 [@option{-s} @var{format}|@option{--format=}@var{format}]
2977 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2981 @c man begin DESCRIPTION cxxfilt
2984 The C++ and Java languages provide function overloading, which means
2985 that you can write many functions with the same name, providing that
2986 each function takes parameters of different types. In order to be
2987 able to distinguish these similarly named functions C++ and Java
2988 encode them into a low-level assembler name which uniquely identifies
2989 each different version. This process is known as @dfn{mangling}. The
2991 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2992 MS-DOS this program is named @command{CXXFILT}.}
2993 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2994 names into user-level names so that they can be read.
2996 Every alphanumeric word (consisting of letters, digits, underscores,
2997 dollars, or periods) seen in the input is a potential mangled name.
2998 If the name decodes into a C++ name, the C++ name replaces the
2999 low-level name in the output, otherwise the original word is output.
3000 In this way you can pass an entire assembler source file, containing
3001 mangled names, through @command{c++filt} and see the same source file
3002 containing demangled names.
3004 You can also use @command{c++filt} to decipher individual symbols by
3005 passing them on the command line:
3008 c++filt @var{symbol}
3011 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3012 names from the standard input instead. All the results are printed on
3013 the standard output. The difference between reading names from the
3014 command line versus reading names from the standard input is that
3015 command line arguments are expected to be just mangled names and no
3016 checking is performed to separate them from surrounding text. Thus
3023 will work and demangle the name to ``f()'' whereas:
3029 will not work. (Note the extra comma at the end of the mangled
3030 name which makes it invalid). This command however will work:
3033 echo _Z1fv, | c++filt -n
3036 and will display ``f(),'', i.e., the demangled name followed by a
3037 trailing comma. This behaviour is because when the names are read
3038 from the standard input it is expected that they might be part of an
3039 assembler source file where there might be extra, extraneous
3040 characters trailing after a mangled name. For example:
3043 .type _Z1fv, @@function
3048 @c man begin OPTIONS cxxfilt
3052 @itemx --strip-underscore
3053 On some systems, both the C and C++ compilers put an underscore in front
3054 of every name. For example, the C name @code{foo} gets the low-level
3055 name @code{_foo}. This option removes the initial underscore. Whether
3056 @command{c++filt} removes the underscore by default is target dependent.
3059 @itemx --no-strip-underscore
3060 Do not remove the initial underscore.
3064 When demangling the name of a function, do not display the types of
3065 the function's parameters.
3069 Attempt to demangle types as well as function names. This is disabled
3070 by default since mangled types are normally only used internally in
3071 the compiler, and they can be confused with non-mangled names. For example,
3072 a function called ``a'' treated as a mangled type name would be
3073 demangled to ``signed char''.
3077 Do not include implementation details (if any) in the demangled
3080 @item -s @var{format}
3081 @itemx --format=@var{format}
3082 @command{c++filt} can decode various methods of mangling, used by
3083 different compilers. The argument to this option selects which
3088 Automatic selection based on executable (the default method)
3090 the one used by the @sc{gnu} C++ compiler (g++)
3092 the one used by the Lucid compiler (lcc)
3094 the one specified by the C++ Annotated Reference Manual
3096 the one used by the HP compiler (aCC)
3098 the one used by the EDG compiler
3100 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3102 the one used by the @sc{gnu} Java compiler (gcj)
3104 the one used by the @sc{gnu} Ada compiler (GNAT).
3108 Print a summary of the options to @command{c++filt} and exit.
3111 Print the version number of @command{c++filt} and exit.
3117 @c man begin SEEALSO cxxfilt
3118 the Info entries for @file{binutils}.
3123 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3124 user interface are subject to change in future releases. In particular,
3125 a command-line option may be required in the future to decode a name
3126 passed as an argument on the command line; in other words,
3129 c++filt @var{symbol}
3133 may in a future release become
3136 c++filt @var{option} @var{symbol}
3144 @cindex address to file name and line number
3146 @c man title addr2line convert addresses into file names and line numbers.
3149 @c man begin SYNOPSIS addr2line
3150 addr2line [@option{-a}|@option{--addresses}]
3151 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3152 [@option{-C}|@option{--demangle}[=@var{style}]]
3153 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3154 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3155 [@option{-i}|@option{--inlines}]
3156 [@option{-p}|@option{--pretty-print}]
3157 [@option{-j}|@option{--section=}@var{name}]
3158 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3163 @c man begin DESCRIPTION addr2line
3165 @command{addr2line} translates addresses into file names and line numbers.
3166 Given an address in an executable or an offset in a section of a relocatable
3167 object, it uses the debugging information to figure out which file name and
3168 line number are associated with it.
3170 The executable or relocatable object to use is specified with the @option{-e}
3171 option. The default is the file @file{a.out}. The section in the relocatable
3172 object to use is specified with the @option{-j} option.
3174 @command{addr2line} has two modes of operation.
3176 In the first, hexadecimal addresses are specified on the command line,
3177 and @command{addr2line} displays the file name and line number for each
3180 In the second, @command{addr2line} reads hexadecimal addresses from
3181 standard input, and prints the file name and line number for each
3182 address on standard output. In this mode, @command{addr2line} may be used
3183 in a pipe to convert dynamically chosen addresses.
3185 The format of the output is @samp{FILENAME:LINENO}. The file name and
3186 line number for each input address is printed on separate lines.
3188 If the @option{-f} option is used, then each @samp{FILENAME:LINENO}
3189 line is preceded by @samp{FUNCTIONNAME} which is the name of the
3190 function containing the address.
3192 If the @option{-i} option is used and the code at the given address is
3193 present there because of inlining by the compiler then the
3194 @samp{@{FUNCTIONNAME@} FILENAME:LINENO} information for the inlining
3195 function will be displayed afterwards. This continues recursively
3196 until there is no more inlining to report.
3198 If the @option{-a} option is used then the output is prefixed by the
3201 If the @option{-p} option is used then the output for each input
3202 address is displayed on one, possibly quite long, line. If
3203 @option{-p} is not used then the output is broken up into multiple
3204 lines, based on the paragraphs above.
3206 If the file name or function name can not be determined,
3207 @command{addr2line} will print two question marks in their place. If the
3208 line number can not be determined, @command{addr2line} will print 0.
3212 @c man begin OPTIONS addr2line
3214 The long and short forms of options, shown here as alternatives, are
3220 Display the address before the function name, file and line number
3221 information. The address is printed with a @samp{0x} prefix to easily
3224 @item -b @var{bfdname}
3225 @itemx --target=@var{bfdname}
3226 @cindex object code format
3227 Specify that the object-code format for the object files is
3231 @itemx --demangle[=@var{style}]
3232 @cindex demangling in objdump
3233 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3234 Besides removing any initial underscore prepended by the system, this
3235 makes C++ function names readable. Different compilers have different
3236 mangling styles. The optional demangling style argument can be used to
3237 choose an appropriate demangling style for your compiler. @xref{c++filt},
3238 for more information on demangling.
3240 @item -e @var{filename}
3241 @itemx --exe=@var{filename}
3242 Specify the name of the executable for which addresses should be
3243 translated. The default file is @file{a.out}.
3247 Display function names as well as file and line number information.
3251 Display only the base of each file name.
3255 If the address belongs to a function that was inlined, the source
3256 information for all enclosing scopes back to the first non-inlined
3257 function will also be printed. For example, if @code{main} inlines
3258 @code{callee1} which inlines @code{callee2}, and address is from
3259 @code{callee2}, the source information for @code{callee1} and @code{main}
3260 will also be printed.
3264 Read offsets relative to the specified section instead of absolute addresses.
3267 @itemx --pretty-print
3268 Make the output more human friendly: each location are printed on one line.
3269 If option @option{-i} is specified, lines for all enclosing scopes are
3270 prefixed with @samp{(inlined by)}.
3276 @c man begin SEEALSO addr2line
3277 Info entries for @file{binutils}.
3284 @command{nlmconv} converts a relocatable object file into a NetWare
3288 @command{nlmconv} currently works with @samp{i386} object
3289 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3290 object files in @sc{elf}, or @code{a.out} format@footnote{
3291 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3292 format in the Binary File Descriptor library. It has only been tested
3293 with the above formats.}.
3297 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3298 utilities, since it is only useful for NLM targets.
3301 @c man title nlmconv converts object code into an NLM.
3304 @c man begin SYNOPSIS nlmconv
3305 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3306 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3307 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3308 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3309 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3310 @var{infile} @var{outfile}
3314 @c man begin DESCRIPTION nlmconv
3316 @command{nlmconv} converts the relocatable @samp{i386} object file
3317 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3318 reading @var{headerfile} for NLM header information. For instructions
3319 on writing the NLM command file language used in header files, see the
3320 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3321 Development and Tools Overview}, which is part of the NLM Software
3322 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3323 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3326 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3329 @command{nlmconv} can perform a link step. In other words, you can list
3330 more than one object file for input if you list them in the definitions
3331 file (rather than simply specifying one input file on the command line).
3332 In this case, @command{nlmconv} calls the linker for you.
3336 @c man begin OPTIONS nlmconv
3339 @item -I @var{bfdname}
3340 @itemx --input-target=@var{bfdname}
3341 Object format of the input file. @command{nlmconv} can usually determine
3342 the format of a given file (so no default is necessary).
3343 @xref{Target Selection}, for more information.
3345 @item -O @var{bfdname}
3346 @itemx --output-target=@var{bfdname}
3347 Object format of the output file. @command{nlmconv} infers the output
3348 format based on the input format, e.g. for a @samp{i386} input file the
3349 output format is @samp{nlm32-i386}.
3350 @xref{Target Selection}, for more information.
3352 @item -T @var{headerfile}
3353 @itemx --header-file=@var{headerfile}
3354 Reads @var{headerfile} for NLM header information. For instructions on
3355 writing the NLM command file language used in header files, see@ see the
3356 @samp{linkers} section, of the @cite{NLM Development and Tools
3357 Overview}, which is part of the NLM Software Developer's Kit, available
3362 Displays (on standard error) the linker command line used by @command{nlmconv}.
3364 @item -l @var{linker}
3365 @itemx --linker=@var{linker}
3366 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3371 Prints a usage summary.
3375 Prints the version number for @command{nlmconv}.
3381 @c man begin SEEALSO nlmconv
3382 the Info entries for @file{binutils}.
3389 @command{windmc} may be used to generator Windows message resources.
3392 @emph{Warning:} @command{windmc} is not always built as part of the binary
3393 utilities, since it is only useful for Windows targets.
3396 @c man title windmc generates Windows message resources.
3399 @c man begin SYNOPSIS windmc
3400 windmc [options] input-file
3404 @c man begin DESCRIPTION windmc
3406 @command{windmc} reads message definitions from an input file (.mc) and
3407 translate them into a set of output files. The output files may be of
3412 A C header file containing the message definitions.
3415 A resource file compilable by the @command{windres} tool.
3418 One or more binary files containing the resource data for a specific
3422 A C include file that maps message id's to their symbolic name.
3425 The exact description of these different formats is available in
3426 documentation from Microsoft.
3428 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3429 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3430 Windows Message Compiler.
3434 @c man begin OPTIONS windmc
3439 Specifies that the input file specified is ASCII. This is the default
3444 Specifies that messages in the output @code{bin} files should be in ASCII
3449 Specifies that @code{bin} filenames should have to be prefixed by the
3450 basename of the source file.
3454 Sets the customer bit in all message id's.
3456 @item -C @var{codepage}
3457 @itemx --codepage_in @var{codepage}
3458 Sets the default codepage to be used to convert input file to UTF16. The
3459 default is ocdepage 1252.
3462 @itemx --decimal_values
3463 Outputs the constants in the header file in decimal. Default is using
3467 @itemx --extension @var{ext}
3468 The extension for the header file. The default is .h extension.
3470 @item -F @var{target}
3471 @itemx --target @var{target}
3472 Specify the BFD format to use for a bin file as output. This
3473 is a BFD target name; you can use the @option{--help} option to see a list
3474 of supported targets. Normally @command{windmc} will use the default
3475 format, which is the first one listed by the @option{--help} option.
3477 @ref{Target Selection}.
3481 @itemx --headerdir @var{path}
3482 The target directory of the generated header file. The default is the
3487 Displays a list of command line options and then exits.
3489 @item -m @var{characters}
3490 @itemx --maxlength @var{characters}
3491 Instructs @command{windmc} to generate a warning if the length
3492 of any message exceeds the number specified.
3495 @itemx --nullterminate
3496 Terminate message text in @code{bin} files by zero. By default they are
3497 terminated by CR/LF.
3500 @itemx --hresult_use
3501 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3502 file, using HRESULT definitions. Status codes are used if the flag is not
3505 @item -O @var{codepage}
3506 @itemx --codepage_out @var{codepage}
3507 Sets the default codepage to be used to output text files. The default
3511 @itemx --rcdir @var{path}
3512 The target directory for the generated @code{rc} script and the generated
3513 @code{bin} files that the resource compiler script includes. The default
3514 is the current directory.
3518 Specifies that the input file is UTF16.
3521 @itemx --unicode_out
3522 Specifies that messages in the output @code{bin} file should be in UTF16
3523 format. This is the default behaviour.
3527 Enable verbose mode.
3531 Prints the version number for @command{windmc}.
3534 @itemx --xdgb @var{path}
3535 The path of the @code{dbg} C include file that maps message id's to the
3536 symbolic name. No such file is generated without specifying the switch.
3542 @c man begin SEEALSO windmc
3543 the Info entries for @file{binutils}.
3550 @command{windres} may be used to manipulate Windows resources.
3553 @emph{Warning:} @command{windres} is not always built as part of the binary
3554 utilities, since it is only useful for Windows targets.
3557 @c man title windres manipulate Windows resources.
3560 @c man begin SYNOPSIS windres
3561 windres [options] [input-file] [output-file]
3565 @c man begin DESCRIPTION windres
3567 @command{windres} reads resources from an input file and copies them into
3568 an output file. Either file may be in one of three formats:
3572 A text format read by the Resource Compiler.
3575 A binary format generated by the Resource Compiler.
3578 A COFF object or executable.
3581 The exact description of these different formats is available in
3582 documentation from Microsoft.
3584 When @command{windres} converts from the @code{rc} format to the @code{res}
3585 format, it is acting like the Windows Resource Compiler. When
3586 @command{windres} converts from the @code{res} format to the @code{coff}
3587 format, it is acting like the Windows @code{CVTRES} program.
3589 When @command{windres} generates an @code{rc} file, the output is similar
3590 but not identical to the format expected for the input. When an input
3591 @code{rc} file refers to an external filename, an output @code{rc} file
3592 will instead include the file contents.
3594 If the input or output format is not specified, @command{windres} will
3595 guess based on the file name, or, for the input file, the file contents.
3596 A file with an extension of @file{.rc} will be treated as an @code{rc}
3597 file, a file with an extension of @file{.res} will be treated as a
3598 @code{res} file, and a file with an extension of @file{.o} or
3599 @file{.exe} will be treated as a @code{coff} file.
3601 If no output file is specified, @command{windres} will print the resources
3602 in @code{rc} format to standard output.
3604 The normal use is for you to write an @code{rc} file, use @command{windres}
3605 to convert it to a COFF object file, and then link the COFF file into
3606 your application. This will make the resources described in the
3607 @code{rc} file available to Windows.
3611 @c man begin OPTIONS windres
3614 @item -i @var{filename}
3615 @itemx --input @var{filename}
3616 The name of the input file. If this option is not used, then
3617 @command{windres} will use the first non-option argument as the input file
3618 name. If there are no non-option arguments, then @command{windres} will
3619 read from standard input. @command{windres} can not read a COFF file from
3622 @item -o @var{filename}
3623 @itemx --output @var{filename}
3624 The name of the output file. If this option is not used, then
3625 @command{windres} will use the first non-option argument, after any used
3626 for the input file name, as the output file name. If there is no
3627 non-option argument, then @command{windres} will write to standard output.
3628 @command{windres} can not write a COFF file to standard output. Note,
3629 for compatibility with @command{rc} the option @option{-fo} is also
3630 accepted, but its use is not recommended.
3632 @item -J @var{format}
3633 @itemx --input-format @var{format}
3634 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3635 @samp{coff}. If no input format is specified, @command{windres} will
3636 guess, as described above.
3638 @item -O @var{format}
3639 @itemx --output-format @var{format}
3640 The output format to generate. @var{format} may be @samp{res},
3641 @samp{rc}, or @samp{coff}. If no output format is specified,
3642 @command{windres} will guess, as described above.
3644 @item -F @var{target}
3645 @itemx --target @var{target}
3646 Specify the BFD format to use for a COFF file as input or output. This
3647 is a BFD target name; you can use the @option{--help} option to see a list
3648 of supported targets. Normally @command{windres} will use the default
3649 format, which is the first one listed by the @option{--help} option.
3651 @ref{Target Selection}.
3654 @item --preprocessor @var{program}
3655 When @command{windres} reads an @code{rc} file, it runs it through the C
3656 preprocessor first. This option may be used to specify the preprocessor
3657 to use, including any leading arguments. The default preprocessor
3658 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3660 @item --preprocessor-arg @var{option}
3661 When @command{windres} reads an @code{rc} file, it runs it through
3662 the C preprocessor first. This option may be used to specify additional
3663 text to be passed to preprocessor on its command line.
3664 This option can be used multiple times to add multiple options to the
3665 preprocessor command line.
3667 @item -I @var{directory}
3668 @itemx --include-dir @var{directory}
3669 Specify an include directory to use when reading an @code{rc} file.
3670 @command{windres} will pass this to the preprocessor as an @option{-I}
3671 option. @command{windres} will also search this directory when looking for
3672 files named in the @code{rc} file. If the argument passed to this command
3673 matches any of the supported @var{formats} (as described in the @option{-J}
3674 option), it will issue a deprecation warning, and behave just like the
3675 @option{-J} option. New programs should not use this behaviour. If a
3676 directory happens to match a @var{format}, simple prefix it with @samp{./}
3677 to disable the backward compatibility.
3679 @item -D @var{target}
3680 @itemx --define @var{sym}[=@var{val}]
3681 Specify a @option{-D} option to pass to the preprocessor when reading an
3684 @item -U @var{target}
3685 @itemx --undefine @var{sym}
3686 Specify a @option{-U} option to pass to the preprocessor when reading an
3690 Ignored for compatibility with rc.
3693 Enable verbose mode. This tells you what the preprocessor is if you
3697 @item --codepage @var{val}
3698 Specify the default codepage to use when reading an @code{rc} file.
3699 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3700 codepage code. The valid range is from zero up to 0xffff, but the
3701 validity of the codepage is host and configuration dependent.
3704 @item --language @var{val}
3705 Specify the default language to use when reading an @code{rc} file.
3706 @var{val} should be a hexadecimal language code. The low eight bits are
3707 the language, and the high eight bits are the sublanguage.
3709 @item --use-temp-file
3710 Use a temporary file to instead of using popen to read the output of
3711 the preprocessor. Use this option if the popen implementation is buggy
3712 on the host (eg., certain non-English language versions of Windows 95 and
3713 Windows 98 are known to have buggy popen where the output will instead
3716 @item --no-use-temp-file
3717 Use popen, not a temporary file, to read the output of the preprocessor.
3718 This is the default behaviour.
3722 Prints a usage summary.
3726 Prints the version number for @command{windres}.
3729 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3730 this will turn on parser debugging.
3736 @c man begin SEEALSO windres
3737 the Info entries for @file{binutils}.
3746 @command{dlltool} is used to create the files needed to create dynamic
3747 link libraries (DLLs) on systems which understand PE format image
3748 files such as Windows. A DLL contains an export table which contains
3749 information that the runtime loader needs to resolve references from a
3750 referencing program.
3752 The export table is generated by this program by reading in a
3753 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3754 will be in the DLL. A @file{.o} file can contain information in
3755 special @samp{.drectve} sections with export information.
3758 @emph{Note:} @command{dlltool} is not always built as part of the
3759 binary utilities, since it is only useful for those targets which
3763 @c man title dlltool Create files needed to build and use DLLs.
3766 @c man begin SYNOPSIS dlltool
3767 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3768 [@option{-b}|@option{--base-file} @var{base-file-name}]
3769 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3770 [@option{-z}|@option{--output-def} @var{def-file-name}]
3771 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3772 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3773 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3774 [@option{--exclude-symbols} @var{list}]
3775 [@option{--no-default-excludes}]
3776 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3777 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3778 [@option{-a}|@option{--add-indirect}]
3779 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3780 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3781 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3782 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3783 [@option{--use-nul-prefixed-import-tables}]
3784 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3785 [@option{-i}|@option{--interwork}]
3786 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3787 [@option{-v}|@option{--verbose}]
3788 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3789 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
3790 [object-file @dots{}]
3794 @c man begin DESCRIPTION dlltool
3796 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3797 @option{-b} options as well as object files specified on the command
3798 line. It then processes these inputs and if the @option{-e} option has
3799 been specified it creates a exports file. If the @option{-l} option
3800 has been specified it creates a library file and if the @option{-z} option
3801 has been specified it creates a def file. Any or all of the @option{-e},
3802 @option{-l} and @option{-z} options can be present in one invocation of
3805 When creating a DLL, along with the source for the DLL, it is necessary
3806 to have three other files. @command{dlltool} can help with the creation of
3809 The first file is a @file{.def} file which specifies which functions are
3810 exported from the DLL, which functions the DLL imports, and so on. This
3811 is a text file and can be created by hand, or @command{dlltool} can be used
3812 to create it using the @option{-z} option. In this case @command{dlltool}
3813 will scan the object files specified on its command line looking for
3814 those functions which have been specially marked as being exported and
3815 put entries for them in the @file{.def} file it creates.
3817 In order to mark a function as being exported from a DLL, it needs to
3818 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3819 section of the object file. This can be done in C by using the
3823 asm (".section .drectve");
3824 asm (".ascii \"-export:my_func\"");
3826 int my_func (void) @{ @dots{} @}
3829 The second file needed for DLL creation is an exports file. This file
3830 is linked with the object files that make up the body of the DLL and it
3831 handles the interface between the DLL and the outside world. This is a
3832 binary file and it can be created by giving the @option{-e} option to
3833 @command{dlltool} when it is creating or reading in a @file{.def} file.
3835 The third file needed for DLL creation is the library file that programs
3836 will link with in order to access the functions in the DLL (an `import
3837 library'). This file can be created by giving the @option{-l} option to
3838 dlltool when it is creating or reading in a @file{.def} file.
3840 If the @option{-y} option is specified, dlltool generates a delay-import
3841 library that can be used instead of the normal import library to allow
3842 a program to link to the dll only as soon as an imported function is
3843 called for the first time. The resulting executable will need to be
3844 linked to the static delayimp library containing __delayLoadHelper2(),
3845 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
3847 @command{dlltool} builds the library file by hand, but it builds the
3848 exports file by creating temporary files containing assembler statements
3849 and then assembling these. The @option{-S} command line option can be
3850 used to specify the path to the assembler that dlltool will use,
3851 and the @option{-f} option can be used to pass specific flags to that
3852 assembler. The @option{-n} can be used to prevent dlltool from deleting
3853 these temporary assembler files when it is done, and if @option{-n} is
3854 specified twice then this will prevent dlltool from deleting the
3855 temporary object files it used to build the library.
3857 Here is an example of creating a DLL from a source file @samp{dll.c} and
3858 also creating a program (from an object file called @samp{program.o})
3863 dlltool -e exports.o -l dll.lib dll.o
3864 gcc dll.o exports.o -o dll.dll
3865 gcc program.o dll.lib -o program
3869 @command{dlltool} may also be used to query an existing import library
3870 to determine the name of the DLL to which it is associated. See the
3871 description of the @option{-I} or @option{--identify} option.
3875 @c man begin OPTIONS dlltool
3877 The command line options have the following meanings:
3881 @item -d @var{filename}
3882 @itemx --input-def @var{filename}
3883 @cindex input .def file
3884 Specifies the name of a @file{.def} file to be read in and processed.
3886 @item -b @var{filename}
3887 @itemx --base-file @var{filename}
3889 Specifies the name of a base file to be read in and processed. The
3890 contents of this file will be added to the relocation section in the
3891 exports file generated by dlltool.
3893 @item -e @var{filename}
3894 @itemx --output-exp @var{filename}
3895 Specifies the name of the export file to be created by dlltool.
3897 @item -z @var{filename}
3898 @itemx --output-def @var{filename}
3899 Specifies the name of the @file{.def} file to be created by dlltool.
3901 @item -l @var{filename}
3902 @itemx --output-lib @var{filename}
3903 Specifies the name of the library file to be created by dlltool.
3905 @item -y @var{filename}
3906 @itemx --output-delaylib @var{filename}
3907 Specifies the name of the delay-import library file to be created by dlltool.
3909 @item --export-all-symbols
3910 Treat all global and weak defined symbols found in the input object
3911 files as symbols to be exported. There is a small list of symbols which
3912 are not exported by default; see the @option{--no-default-excludes}
3913 option. You may add to the list of symbols to not export by using the
3914 @option{--exclude-symbols} option.
3916 @item --no-export-all-symbols
3917 Only export symbols explicitly listed in an input @file{.def} file or in
3918 @samp{.drectve} sections in the input object files. This is the default
3919 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3920 attributes in the source code.
3922 @item --exclude-symbols @var{list}
3923 Do not export the symbols in @var{list}. This is a list of symbol names
3924 separated by comma or colon characters. The symbol names should not
3925 contain a leading underscore. This is only meaningful when
3926 @option{--export-all-symbols} is used.
3928 @item --no-default-excludes
3929 When @option{--export-all-symbols} is used, it will by default avoid
3930 exporting certain special symbols. The current list of symbols to avoid
3931 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3932 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3933 to go ahead and export these special symbols. This is only meaningful
3934 when @option{--export-all-symbols} is used.
3937 @itemx --as @var{path}
3938 Specifies the path, including the filename, of the assembler to be used
3939 to create the exports file.
3941 @item -f @var{options}
3942 @itemx --as-flags @var{options}
3943 Specifies any specific command line options to be passed to the
3944 assembler when building the exports file. This option will work even if
3945 the @option{-S} option is not used. This option only takes one argument,
3946 and if it occurs more than once on the command line, then later
3947 occurrences will override earlier occurrences. So if it is necessary to
3948 pass multiple options to the assembler they should be enclosed in
3952 @itemx --dll-name @var{name}
3953 Specifies the name to be stored in the @file{.def} file as the name of
3954 the DLL when the @option{-e} option is used. If this option is not
3955 present, then the filename given to the @option{-e} option will be
3956 used as the name of the DLL.
3958 @item -m @var{machine}
3959 @itemx -machine @var{machine}
3960 Specifies the type of machine for which the library file should be
3961 built. @command{dlltool} has a built in default type, depending upon how
3962 it was created, but this option can be used to override that. This is
3963 normally only useful when creating DLLs for an ARM processor, when the
3964 contents of the DLL are actually encode using Thumb instructions.
3967 @itemx --add-indirect
3968 Specifies that when @command{dlltool} is creating the exports file it
3969 should add a section which allows the exported functions to be
3970 referenced without using the import library. Whatever the hell that
3974 @itemx --add-underscore
3975 Specifies that when @command{dlltool} is creating the exports file it
3976 should prepend an underscore to the names of @emph{all} exported symbols.
3978 @item --no-leading-underscore
3979 @item --leading-underscore
3980 Specifies whether standard symbol should be forced to be prefixed, or
3983 @item --add-stdcall-underscore
3984 Specifies that when @command{dlltool} is creating the exports file it
3985 should prepend an underscore to the names of exported @emph{stdcall}
3986 functions. Variable names and non-stdcall function names are not modified.
3987 This option is useful when creating GNU-compatible import libs for third
3988 party DLLs that were built with MS-Windows tools.
3992 Specifies that when @command{dlltool} is creating the exports file it
3993 should not append the string @samp{@@ <number>}. These numbers are
3994 called ordinal numbers and they represent another way of accessing the
3995 function in a DLL, other than by name.
3998 @itemx --add-stdcall-alias
3999 Specifies that when @command{dlltool} is creating the exports file it
4000 should add aliases for stdcall symbols without @samp{@@ <number>}
4001 in addition to the symbols with @samp{@@ <number>}.
4004 @itemx --ext-prefix-alias @var{prefix}
4005 Causes @command{dlltool} to create external aliases for all DLL
4006 imports with the specified prefix. The aliases are created for both
4007 external and import symbols with no leading underscore.
4011 Specifies that when @command{dlltool} is creating the exports and library
4012 files it should omit the @code{.idata4} section. This is for compatibility
4013 with certain operating systems.
4015 @item --use-nul-prefixed-import-tables
4016 Specifies that when @command{dlltool} is creating the exports and library
4017 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4018 element. This emulates old gnu import library generation of
4019 @code{dlltool}. By default this option is turned off.
4023 Specifies that when @command{dlltool} is creating the exports and library
4024 files it should omit the @code{.idata5} section. This is for compatibility
4025 with certain operating systems.
4027 @item -I @var{filename}
4028 @itemx --identify @var{filename}
4029 Specifies that @command{dlltool} should inspect the import library
4030 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4031 of the associated DLL(s). This can be performed in addition to any
4032 other operations indicated by the other options and arguments.
4033 @command{dlltool} fails if the import library does not exist or is not
4034 actually an import library. See also @option{--identify-strict}.
4036 @item --identify-strict
4037 Modifies the behavior of the @option{--identify} option, such
4038 that an error is reported if @var{filename} is associated with
4043 Specifies that @command{dlltool} should mark the objects in the library
4044 file and exports file that it produces as supporting interworking
4045 between ARM and Thumb code.
4049 Makes @command{dlltool} preserve the temporary assembler files it used to
4050 create the exports file. If this option is repeated then dlltool will
4051 also preserve the temporary object files it uses to create the library
4054 @item -t @var{prefix}
4055 @itemx --temp-prefix @var{prefix}
4056 Makes @command{dlltool} use @var{prefix} when constructing the names of
4057 temporary assembler and object files. By default, the temp file prefix
4058 is generated from the pid.
4062 Make dlltool describe what it is doing.
4066 Displays a list of command line options and then exits.
4070 Displays dlltool's version number and then exits.
4077 * def file format:: The format of the dlltool @file{.def} file
4080 @node def file format
4081 @section The format of the @command{dlltool} @file{.def} file
4083 A @file{.def} file contains any number of the following commands:
4087 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4088 The result is going to be named @var{name}@code{.exe}.
4090 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4091 The result is going to be named @var{name}@code{.dll}.
4092 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4093 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4096 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4097 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4098 Declares @var{name1} as an exported symbol from the DLL, with optional
4099 ordinal number @var{integer}, or declares @var{name1} as an alias
4100 (forward) of the function @var{external-name} in the DLL.
4101 If @var{its_name} is specified, this name is used as string in export table.
4103 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4104 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4105 If you want to use LIBRARY as name then you need to quote it.
4107 @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{]} *}
4108 Declares that @var{external-name} or the exported function whose
4109 ordinal number is @var{integer} is to be imported from the file
4110 @var{module-name}. If @var{internal-name} is specified then this is
4111 the name that the imported function will be referred to in the body of
4113 If @var{its_name} is specified, this name is used as string in import table.
4114 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4115 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4116 If you want to use LIBRARY as name then you need to quote it.
4118 @item @code{DESCRIPTION} @var{string}
4119 Puts @var{string} into the output @file{.exp} file in the
4120 @code{.rdata} section.
4122 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4123 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4124 Generates @code{--stack} or @code{--heap}
4125 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4126 section. The linker will see this and act upon it.
4128 @item @code{CODE} @var{attr} @code{+}
4129 @item @code{DATA} @var{attr} @code{+}
4130 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4131 Generates @code{--attr} @var{section-name} @var{attr} in the output
4132 @code{.drectve} section, where @var{attr} is one of @code{READ},
4133 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4134 this and act upon it.
4139 @c man begin SEEALSO dlltool
4140 The Info pages for @file{binutils}.
4147 @cindex ELF file information
4150 @c man title readelf Displays information about ELF files.
4153 @c man begin SYNOPSIS readelf
4154 readelf [@option{-a}|@option{--all}]
4155 [@option{-h}|@option{--file-header}]
4156 [@option{-l}|@option{--program-headers}|@option{--segments}]
4157 [@option{-S}|@option{--section-headers}|@option{--sections}]
4158 [@option{-g}|@option{--section-groups}]
4159 [@option{-t}|@option{--section-details}]
4160 [@option{-e}|@option{--headers}]
4161 [@option{-s}|@option{--syms}|@option{--symbols}]
4162 [@option{--dyn-syms}]
4163 [@option{-n}|@option{--notes}]
4164 [@option{-r}|@option{--relocs}]
4165 [@option{-u}|@option{--unwind}]
4166 [@option{-d}|@option{--dynamic}]
4167 [@option{-V}|@option{--version-info}]
4168 [@option{-A}|@option{--arch-specific}]
4169 [@option{-D}|@option{--use-dynamic}]
4170 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4171 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4172 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4173 [@option{-c}|@option{--archive-index}]
4174 [@option{-w[lLiaprmfFsoRt]}|
4175 @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]]
4176 [@option{--dwarf-depth=@var{n}}]
4177 [@option{--dwarf-start=@var{n}}]
4178 [@option{-I}|@option{--histogram}]
4179 [@option{-v}|@option{--version}]
4180 [@option{-W}|@option{--wide}]
4181 [@option{-H}|@option{--help}]
4182 @var{elffile}@dots{}
4186 @c man begin DESCRIPTION readelf
4188 @command{readelf} displays information about one or more ELF format object
4189 files. The options control what particular information to display.
4191 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4192 64-bit ELF files are supported, as are archives containing ELF files.
4194 This program performs a similar function to @command{objdump} but it
4195 goes into more detail and it exists independently of the @sc{bfd}
4196 library, so if there is a bug in @sc{bfd} then readelf will not be
4201 @c man begin OPTIONS readelf
4203 The long and short forms of options, shown here as alternatives, are
4204 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4210 Equivalent to specifying @option{--file-header},
4211 @option{--program-headers}, @option{--sections}, @option{--symbols},
4212 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4213 @option{--version-info}.
4216 @itemx --file-header
4217 @cindex ELF file header information
4218 Displays the information contained in the ELF header at the start of the
4222 @itemx --program-headers
4224 @cindex ELF program header information
4225 @cindex ELF segment information
4226 Displays the information contained in the file's segment headers, if it
4231 @itemx --section-headers
4232 @cindex ELF section information
4233 Displays the information contained in the file's section headers, if it
4237 @itemx --section-groups
4238 @cindex ELF section group information
4239 Displays the information contained in the file's section groups, if it
4243 @itemx --section-details
4244 @cindex ELF section information
4245 Displays the detailed section information. Implies @option{-S}.
4250 @cindex ELF symbol table information
4251 Displays the entries in symbol table section of the file, if it has one.
4254 @cindex ELF dynamic symbol table information
4255 Displays the entries in dynamic symbol table section of the file, if it
4260 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4265 Displays the contents of the NOTE segments and/or sections, if any.
4269 @cindex ELF reloc information
4270 Displays the contents of the file's relocation section, if it has one.
4274 @cindex unwind information
4275 Displays the contents of the file's unwind section, if it has one. Only
4276 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4277 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4281 @cindex ELF dynamic section information
4282 Displays the contents of the file's dynamic section, if it has one.
4285 @itemx --version-info
4286 @cindex ELF version sections information
4287 Displays the contents of the version sections in the file, it they
4291 @itemx --arch-specific
4292 Displays architecture-specific information in the file, if there
4296 @itemx --use-dynamic
4297 When displaying symbols, this option makes @command{readelf} use the
4298 symbol hash tables in the file's dynamic section, rather than the
4299 symbol table sections.
4301 @item -x <number or name>
4302 @itemx --hex-dump=<number or name>
4303 Displays the contents of the indicated section as a hexadecimal bytes.
4304 A number identifies a particular section by index in the section table;
4305 any other string identifies all sections with that name in the object file.
4307 @item -R <number or name>
4308 @itemx --relocated-dump=<number or name>
4309 Displays the contents of the indicated section as a hexadecimal
4310 bytes. A number identifies a particular section by index in the
4311 section table; any other string identifies all sections with that name
4312 in the object file. The contents of the section will be relocated
4313 before they are displayed.
4315 @item -p <number or name>
4316 @itemx --string-dump=<number or name>
4317 Displays the contents of the indicated section as printable strings.
4318 A number identifies a particular section by index in the section table;
4319 any other string identifies all sections with that name in the object file.
4322 @itemx --archive-index
4323 @cindex Archive file symbol index information
4324 Displays the file symbol index information contained in the header part
4325 of binary archives. Performs the same function as the @option{t}
4326 command to @command{ar}, but without using the BFD library. @xref{ar}.
4328 @item -w[lLiaprmfFsoRt]
4329 @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]
4330 Displays the contents of the debug sections in the file, if any are
4331 present. If one of the optional letters or words follows the switch
4332 then only data found in those specific sections will be dumped.
4334 Note that there is no single letter option to display the content of
4335 trace sections or .gdb_index.
4337 Note: the @option{=decodedline} option will display the interpreted
4338 contents of a .debug_line section whereas the @option{=rawline} option
4339 dumps the contents in a raw format.
4341 Note: the @option{=frames-interp} option will display the interpreted
4342 contents of a .debug_frame section whereas the @option{=frames} option
4343 dumps the contents in a raw format.
4345 Note: the output from the @option{=info} option can also be affected
4346 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4348 @item --dwarf-depth=@var{n}
4349 Limit the dump of the @code{.debug_info} section to @var{n} children.
4350 This is only useful with @option{--debug-dump=info}. The default is
4351 to print all DIEs; the special value 0 for @var{n} will also have this
4354 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4355 levels will not be printed. The range for @var{n} is zero-based.
4357 @item --dwarf-start=@var{n}
4358 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4359 useful with @option{--debug-dump=info}.
4361 If specified, this option will suppress printing of any header
4362 information and all DIEs before the DIE numbered @var{n}. Only
4363 siblings and children of the specified DIE will be printed.
4365 This can be used in conjunction with @option{--dwarf-depth}.
4369 Display a histogram of bucket list lengths when displaying the contents
4370 of the symbol tables.
4374 Display the version number of readelf.
4378 Don't break output lines to fit into 80 columns. By default
4379 @command{readelf} breaks section header and segment listing lines for
4380 64-bit ELF files, so that they fit into 80 columns. This option causes
4381 @command{readelf} to print each section header resp. each segment one a
4382 single line, which is far more readable on terminals wider than 80 columns.
4386 Display the command line options understood by @command{readelf}.
4393 @c man begin SEEALSO readelf
4394 objdump(1), and the Info entries for @file{binutils}.
4401 @cindex Update ELF header
4404 @c man title elfedit Update the ELF header of ELF files.
4407 @c man begin SYNOPSIS elfedit
4408 elfedit [@option{--input-mach=}@var{machine}]
4409 [@option{--input-type=}@var{type}]
4410 [@option{--input-osabi=}@var{osabi}]
4411 @option{--output-mach=}@var{machine}
4412 @option{--output-type=}@var{type}
4413 @option{--output-osabi=}@var{osabi}
4414 [@option{-v}|@option{--version}]
4415 [@option{-h}|@option{--help}]
4416 @var{elffile}@dots{}
4420 @c man begin DESCRIPTION elfedit
4422 @command{elfedit} updates the ELF header of ELF files which have
4423 the matching ELF machine and file types. The options control how and
4424 which fields in the ELF header should be updated.
4426 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4427 64-bit ELF files are supported, as are archives containing ELF files.
4430 @c man begin OPTIONS elfedit
4432 The long and short forms of options, shown here as alternatives, are
4433 equivalent. At least one of the @option{--output-mach},
4434 @option{--output-type} and @option{--output-osabi} options must be given.
4438 @item --input-mach=@var{machine}
4439 Set the matching input ELF machine type to @var{machine}. If
4440 @option{--input-mach} isn't specified, it will match any ELF
4443 The supported ELF machine types are, @var{L1OM}, @var{K1OM} and
4446 @item --output-mach=@var{machine}
4447 Change the ELF machine type in the ELF header to @var{machine}. The
4448 supported ELF machine types are the same as @option{--input-mach}.
4450 @item --input-type=@var{type}
4451 Set the matching input ELF file type to @var{type}. If
4452 @option{--input-type} isn't specified, it will match any ELF file types.
4454 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4456 @item --output-type=@var{type}
4457 Change the ELF file type in the ELF header to @var{type}. The
4458 supported ELF types are the same as @option{--input-type}.
4460 @item --input-osabi=@var{osabi}
4461 Set the matching input ELF file OSABI to @var{osabi}. If
4462 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4464 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4465 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4466 @var{Solaris}, @var{AIX}, @var{Irix},
4467 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4468 @var{NSK}, @var{AROS} and @var{FenixOS}.
4470 @item --output-osabi=@var{osabi}
4471 Change the ELF OSABI in the ELF header to @var{osabi}. The
4472 supported ELF OSABI are the same as @option{--input-osabi}.
4476 Display the version number of @command{elfedit}.
4480 Display the command line options understood by @command{elfedit}.
4487 @c man begin SEEALSO elfedit
4488 readelf(1), and the Info entries for @file{binutils}.
4492 @node Common Options
4493 @chapter Common Options
4495 The following command-line options are supported by all of the
4496 programs described in this manual.
4498 @c man begin OPTIONS
4500 @include at-file.texi
4504 Display the command-line options supported by the program.
4507 Display the version number of the program.
4509 @c man begin OPTIONS
4513 @node Selecting the Target System
4514 @chapter Selecting the Target System
4516 You can specify two aspects of the target system to the @sc{gnu}
4517 binary file utilities, each in several ways:
4527 In the following summaries, the lists of ways to specify values are in
4528 order of decreasing precedence. The ways listed first override those
4531 The commands to list valid values only list the values for which the
4532 programs you are running were configured. If they were configured with
4533 @option{--enable-targets=all}, the commands list most of the available
4534 values, but a few are left out; not all targets can be configured in at
4535 once because some of them can only be configured @dfn{native} (on hosts
4536 with the same type as the target system).
4539 * Target Selection::
4540 * Architecture Selection::
4543 @node Target Selection
4544 @section Target Selection
4546 A @dfn{target} is an object file format. A given target may be
4547 supported for multiple architectures (@pxref{Architecture Selection}).
4548 A target selection may also have variations for different operating
4549 systems or architectures.
4551 The command to list valid target values is @samp{objdump -i}
4552 (the first column of output contains the relevant information).
4554 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4555 @samp{a.out-sunos-big}.
4557 You can also specify a target using a configuration triplet. This is
4558 the same sort of name that is passed to @file{configure} to specify a
4559 target. When you use a configuration triplet as an argument, it must be
4560 fully canonicalized. You can see the canonical version of a triplet by
4561 running the shell script @file{config.sub} which is included with the
4564 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4565 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4567 @subheading @command{objdump} Target
4573 command line option: @option{-b} or @option{--target}
4576 environment variable @code{GNUTARGET}
4579 deduced from the input file
4582 @subheading @command{objcopy} and @command{strip} Input Target
4588 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4591 environment variable @code{GNUTARGET}
4594 deduced from the input file
4597 @subheading @command{objcopy} and @command{strip} Output Target
4603 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4606 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4609 environment variable @code{GNUTARGET}
4612 deduced from the input file
4615 @subheading @command{nm}, @command{size}, and @command{strings} Target
4621 command line option: @option{--target}
4624 environment variable @code{GNUTARGET}
4627 deduced from the input file
4630 @node Architecture Selection
4631 @section Architecture Selection
4633 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4634 to run. Its name may contain a colon, separating the name of the
4635 processor family from the name of the particular @sc{cpu}.
4637 The command to list valid architecture values is @samp{objdump -i} (the
4638 second column contains the relevant information).
4640 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4642 @subheading @command{objdump} Architecture
4648 command line option: @option{-m} or @option{--architecture}
4651 deduced from the input file
4654 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4660 deduced from the input file
4663 @node Reporting Bugs
4664 @chapter Reporting Bugs
4666 @cindex reporting bugs
4668 Your bug reports play an essential role in making the binary utilities
4671 Reporting a bug may help you by bringing a solution to your problem, or
4672 it may not. But in any case the principal function of a bug report is
4673 to help the entire community by making the next version of the binary
4674 utilities work better. Bug reports are your contribution to their
4677 In order for a bug report to serve its purpose, you must include the
4678 information that enables us to fix the bug.
4681 * Bug Criteria:: Have you found a bug?
4682 * Bug Reporting:: How to report bugs
4686 @section Have You Found a Bug?
4687 @cindex bug criteria
4689 If you are not sure whether you have found a bug, here are some guidelines:
4692 @cindex fatal signal
4695 If a binary utility gets a fatal signal, for any input whatever, that is
4696 a bug. Reliable utilities never crash.
4698 @cindex error on valid input
4700 If a binary utility produces an error message for valid input, that is a
4704 If you are an experienced user of binary utilities, your suggestions for
4705 improvement are welcome in any case.
4709 @section How to Report Bugs
4711 @cindex bugs, reporting
4713 A number of companies and individuals offer support for @sc{gnu}
4714 products. If you obtained the binary utilities from a support
4715 organization, we recommend you contact that organization first.
4717 You can find contact information for many support companies and
4718 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4722 In any event, we also recommend that you send bug reports for the binary
4723 utilities to @value{BUGURL}.
4726 The fundamental principle of reporting bugs usefully is this:
4727 @strong{report all the facts}. If you are not sure whether to state a
4728 fact or leave it out, state it!
4730 Often people omit facts because they think they know what causes the
4731 problem and assume that some details do not matter. Thus, you might
4732 assume that the name of a file you use in an example does not matter.
4733 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4734 a stray memory reference which happens to fetch from the location where
4735 that pathname is stored in memory; perhaps, if the pathname were
4736 different, the contents of that location would fool the utility into
4737 doing the right thing despite the bug. Play it safe and give a
4738 specific, complete example. That is the easiest thing for you to do,
4739 and the most helpful.
4741 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4742 it is new to us. Therefore, always write your bug reports on the assumption
4743 that the bug has not been reported previously.
4745 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4746 bell?'' This cannot help us fix a bug, so it is basically useless. We
4747 respond by asking for enough details to enable us to investigate.
4748 You might as well expedite matters by sending them to begin with.
4750 To enable us to fix the bug, you should include all these things:
4754 The version of the utility. Each utility announces it if you start it
4755 with the @option{--version} argument.
4757 Without this, we will not know whether there is any point in looking for
4758 the bug in the current version of the binary utilities.
4761 Any patches you may have applied to the source, including any patches
4762 made to the @code{BFD} library.
4765 The type of machine you are using, and the operating system name and
4769 What compiler (and its version) was used to compile the utilities---e.g.
4773 The command arguments you gave the utility to observe the bug. To
4774 guarantee you will not omit something important, list them all. A copy
4775 of the Makefile (or the output from make) is sufficient.
4777 If we were to try to guess the arguments, we would probably guess wrong
4778 and then we might not encounter the bug.
4781 A complete input file, or set of input files, that will reproduce the
4782 bug. If the utility is reading an object file or files, then it is
4783 generally most helpful to send the actual object files.
4785 If the source files were produced exclusively using @sc{gnu} programs
4786 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4787 may be OK to send the source files rather than the object files. In
4788 this case, be sure to say exactly what version of @command{gcc}, or
4789 whatever, was used to produce the object files. Also say how
4790 @command{gcc}, or whatever, was configured.
4793 A description of what behavior you observe that you believe is
4794 incorrect. For example, ``It gets a fatal signal.''
4796 Of course, if the bug is that the utility gets a fatal signal, then we
4797 will certainly notice it. But if the bug is incorrect output, we might
4798 not notice unless it is glaringly wrong. You might as well not give us
4799 a chance to make a mistake.
4801 Even if the problem you experience is a fatal signal, you should still
4802 say so explicitly. Suppose something strange is going on, such as your
4803 copy of the utility is out of sync, or you have encountered a bug in
4804 the C library on your system. (This has happened!) Your copy might
4805 crash and ours would not. If you told us to expect a crash, then when
4806 ours fails to crash, we would know that the bug was not happening for
4807 us. If you had not told us to expect a crash, then we would not be able
4808 to draw any conclusion from our observations.
4811 If you wish to suggest changes to the source, send us context diffs, as
4812 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4813 option. Always send diffs from the old file to the new file. If you
4814 wish to discuss something in the @command{ld} source, refer to it by
4815 context, not by line number.
4817 The line numbers in our development sources will not match those in your
4818 sources. Your line numbers would convey no useful information to us.
4821 Here are some things that are not necessary:
4825 A description of the envelope of the bug.
4827 Often people who encounter a bug spend a lot of time investigating
4828 which changes to the input file will make the bug go away and which
4829 changes will not affect it.
4831 This is often time consuming and not very useful, because the way we
4832 will find the bug is by running a single example under the debugger
4833 with breakpoints, not by pure deduction from a series of examples.
4834 We recommend that you save your time for something else.
4836 Of course, if you can find a simpler example to report @emph{instead}
4837 of the original one, that is a convenience for us. Errors in the
4838 output will be easier to spot, running under the debugger will take
4839 less time, and so on.
4841 However, simplification is not vital; if you do not want to do this,
4842 report the bug anyway and send us the entire test case you used.
4845 A patch for the bug.
4847 A patch for the bug does help us if it is a good one. But do not omit
4848 the necessary information, such as the test case, on the assumption that
4849 a patch is all we need. We might see problems with your patch and decide
4850 to fix the problem another way, or we might not understand it at all.
4852 Sometimes with programs as complicated as the binary utilities it is
4853 very hard to construct an example that will make the program follow a
4854 certain path through the code. If you do not send us the example, we
4855 will not be able to construct one, so we will not be able to verify that
4858 And if we cannot understand what bug you are trying to fix, or why your
4859 patch should be an improvement, we will not install it. A test case will
4860 help us to understand.
4863 A guess about what the bug is or what it depends on.
4865 Such guesses are usually wrong. Even we cannot guess right about such
4866 things without first using the debugger to find the facts.
4869 @node GNU Free Documentation License
4870 @appendix GNU Free Documentation License
4874 @node Binutils Index
4875 @unnumbered Binutils Index