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 an indirect reference to another symbol.
814 The symbol is a debugging symbol.
817 The symbols is in a stack unwind section.
821 The symbol is in a read only data section.
825 The symbol is in an uninitialized data section for small objects.
829 The symbol is in the text (code) section.
832 The symbol is undefined.
835 The symbol is a unique global symbol. This is a GNU extension to the
836 standard set of ELF symbol bindings. For such a symbol the dynamic linker
837 will make sure that in the entire process there is just one symbol with
838 this name and type in use.
842 The symbol is a weak object. When a weak defined symbol is linked with
843 a normal defined symbol, the normal defined symbol is used with no error.
844 When a weak undefined symbol is linked and the symbol is not defined,
845 the value of the weak symbol becomes zero with no error. On some
846 systems, uppercase indicates that a default value has been specified.
850 The symbol is a weak symbol that has not been specifically tagged as a
851 weak object symbol. When a weak defined symbol is linked with a normal
852 defined symbol, the normal defined symbol is used with no error.
853 When a weak undefined symbol is linked and the symbol is not defined,
854 the value of the symbol is determined in a system-specific manner without
855 error. On some systems, uppercase indicates that a default value has been
859 The symbol is a stabs symbol in an a.out object file. In this case, the
860 next values printed are the stabs other field, the stabs desc field, and
861 the stab type. Stabs symbols are used to hold debugging information.
864 The symbol type is unknown, or object file format specific.
873 @c man begin OPTIONS nm
874 The long and short forms of options, shown here as alternatives, are
880 @itemx --print-file-name
881 @cindex input file name
883 @cindex source file name
884 Precede each symbol by the name of the input file (or archive member)
885 in which it was found, rather than identifying the input file once only,
886 before all of its symbols.
890 @cindex debugging symbols
891 Display all symbols, even debugger-only symbols; normally these are not
895 @cindex @command{nm} format
896 @cindex @command{nm} compatibility
897 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
900 @itemx --demangle[=@var{style}]
901 @cindex demangling in nm
902 Decode (@dfn{demangle}) low-level symbol names into user-level names.
903 Besides removing any initial underscore prepended by the system, this
904 makes C++ function names readable. Different compilers have different
905 mangling styles. The optional demangling style argument can be used to
906 choose an appropriate demangling style for your compiler. @xref{c++filt},
907 for more information on demangling.
910 Do not demangle low-level symbol names. This is the default.
914 @cindex dynamic symbols
915 Display the dynamic symbols rather than the normal symbols. This is
916 only meaningful for dynamic objects, such as certain types of shared
919 @item -f @var{format}
920 @itemx --format=@var{format}
921 @cindex @command{nm} format
922 @cindex @command{nm} compatibility
923 Use the output format @var{format}, which can be @code{bsd},
924 @code{sysv}, or @code{posix}. The default is @code{bsd}.
925 Only the first character of @var{format} is significant; it can be
926 either upper or lower case.
930 @cindex external symbols
931 Display only external symbols.
935 Show a summary of the options to @command{nm} and exit.
938 @itemx --line-numbers
939 @cindex symbol line numbers
940 For each symbol, use debugging information to try to find a filename and
941 line number. For a defined symbol, look for the line number of the
942 address of the symbol. For an undefined symbol, look for the line
943 number of a relocation entry which refers to the symbol. If line number
944 information can be found, print it after the other symbol information.
948 @itemx --numeric-sort
949 Sort symbols numerically by their addresses, rather than alphabetically
954 @cindex sorting symbols
955 Do not bother to sort the symbols in any order; print them in the order
960 Use the POSIX.2 standard output format instead of the default format.
961 Equivalent to @samp{-f posix}.
964 @itemx --reverse-sort
965 Reverse the order of the sort (whether numeric or alphabetic); let the
970 Print both value and size of defined symbols for the @code{bsd} output style.
971 This option has no effect for object formats that do not record symbol
972 sizes, unless @samp{--size-sort} is also used in which case a
973 calculated size is displayed.
977 @cindex symbol index, listing
978 When listing symbols from archive members, include the index: a mapping
979 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
980 contain definitions for which names.
983 @itemx --radix=@var{radix}
984 Use @var{radix} as the radix for printing the symbol values. It must be
985 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
988 @itemx --undefined-only
989 @cindex external symbols
990 @cindex undefined symbols
991 Display only undefined symbols (those external to each object file).
995 Show the version number of @command{nm} and exit.
998 This option is ignored for compatibility with the AIX version of
999 @command{nm}. It takes one parameter which must be the string
1000 @option{32_64}. The default mode of AIX @command{nm} corresponds
1001 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1003 @item --defined-only
1004 @cindex external symbols
1005 @cindex undefined symbols
1006 Display only defined symbols for each object file.
1008 @item --plugin @var{name}
1010 Load the plugin called @var{name} to add support for extra target
1011 types. This option is only available if the toolchain has been built
1012 with plugin support enabled.
1015 Sort symbols by size. The size is computed as the difference between
1016 the value of the symbol and the value of the symbol with the next higher
1017 value. If the @code{bsd} output format is used the size of the symbol
1018 is printed, rather than the value, and @samp{-S} must be used in order
1019 both size and value to be printed.
1021 @item --special-syms
1022 Display symbols which have a target-specific special meaning. These
1023 symbols are usually used by the target for some special processing and
1024 are not normally helpful when included in the normal symbol lists.
1025 For example for ARM targets this option would skip the mapping symbols
1026 used to mark transitions between ARM code, THUMB code and data.
1029 Include synthetic symbols in the output. These are special symbols
1030 created by the linker for various purposes. They are not shown by
1031 default since they are not part of the binary's original source code.
1033 @item --target=@var{bfdname}
1034 @cindex object code format
1035 Specify an object code format other than your system's default format.
1036 @xref{Target Selection}, for more information.
1043 @c man begin SEEALSO nm
1044 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1051 @c man title objcopy copy and translate object files
1054 @c man begin SYNOPSIS objcopy
1055 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1056 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1057 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1058 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1059 [@option{-S}|@option{--strip-all}]
1060 [@option{-g}|@option{--strip-debug}]
1061 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1062 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1063 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1064 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1065 [@option{--localize-hidden}]
1066 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1067 [@option{--globalize-symbol=}@var{symbolname}]
1068 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1069 [@option{-w}|@option{--wildcard}]
1070 [@option{-x}|@option{--discard-all}]
1071 [@option{-X}|@option{--discard-locals}]
1072 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1073 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1074 [@option{--interleave-width=}@var{width}]
1075 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1076 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1077 [@option{-p}|@option{--preserve-dates}]
1078 [@option{-D}|@option{--enable-deterministic-archives}]
1079 [@option{-U}|@option{--disable-deterministic-archives}]
1080 [@option{--debugging}]
1081 [@option{--gap-fill=}@var{val}]
1082 [@option{--pad-to=}@var{address}]
1083 [@option{--set-start=}@var{val}]
1084 [@option{--adjust-start=}@var{incr}]
1085 [@option{--change-addresses=}@var{incr}]
1086 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1087 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1088 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1089 [@option{--change-warnings}] [@option{--no-change-warnings}]
1090 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1091 [@option{--add-section} @var{sectionname}=@var{filename}]
1092 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1093 [@option{--long-section-names} @{enable,disable,keep@}]
1094 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1095 [@option{--reverse-bytes=}@var{num}]
1096 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1097 [@option{--redefine-sym} @var{old}=@var{new}]
1098 [@option{--redefine-syms=}@var{filename}]
1100 [@option{--keep-symbols=}@var{filename}]
1101 [@option{--strip-symbols=}@var{filename}]
1102 [@option{--strip-unneeded-symbols=}@var{filename}]
1103 [@option{--keep-global-symbols=}@var{filename}]
1104 [@option{--localize-symbols=}@var{filename}]
1105 [@option{--globalize-symbols=}@var{filename}]
1106 [@option{--weaken-symbols=}@var{filename}]
1107 [@option{--alt-machine-code=}@var{index}]
1108 [@option{--prefix-symbols=}@var{string}]
1109 [@option{--prefix-sections=}@var{string}]
1110 [@option{--prefix-alloc-sections=}@var{string}]
1111 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1112 [@option{--keep-file-symbols}]
1113 [@option{--only-keep-debug}]
1114 [@option{--strip-dwo}]
1115 [@option{--extract-dwo}]
1116 [@option{--extract-symbol}]
1117 [@option{--writable-text}]
1118 [@option{--readonly-text}]
1121 [@option{--file-alignment=}@var{num}]
1122 [@option{--heap=}@var{size}]
1123 [@option{--image-base=}@var{address}]
1124 [@option{--section-alignment=}@var{num}]
1125 [@option{--stack=}@var{size}]
1126 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1127 [@option{--compress-debug-sections}]
1128 [@option{--decompress-debug-sections}]
1129 [@option{--dwarf-depth=@var{n}}]
1130 [@option{--dwarf-start=@var{n}}]
1131 [@option{-v}|@option{--verbose}]
1132 [@option{-V}|@option{--version}]
1133 [@option{--help}] [@option{--info}]
1134 @var{infile} [@var{outfile}]
1138 @c man begin DESCRIPTION objcopy
1139 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1140 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1141 read and write the object files. It can write the destination object
1142 file in a format different from that of the source object file. The
1143 exact behavior of @command{objcopy} is controlled by command-line options.
1144 Note that @command{objcopy} should be able to copy a fully linked file
1145 between any two formats. However, copying a relocatable object file
1146 between any two formats may not work as expected.
1148 @command{objcopy} creates temporary files to do its translations and
1149 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1150 translation work; it has access to all the formats described in @sc{bfd}
1151 and thus is able to recognize most formats without being told
1152 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1154 @command{objcopy} can be used to generate S-records by using an output
1155 target of @samp{srec} (e.g., use @samp{-O srec}).
1157 @command{objcopy} can be used to generate a raw binary file by using an
1158 output target of @samp{binary} (e.g., use @option{-O binary}). When
1159 @command{objcopy} generates a raw binary file, it will essentially produce
1160 a memory dump of the contents of the input object file. All symbols and
1161 relocation information will be discarded. The memory dump will start at
1162 the load address of the lowest section copied into the output file.
1164 When generating an S-record or a raw binary file, it may be helpful to
1165 use @option{-S} to remove sections containing debugging information. In
1166 some cases @option{-R} will be useful to remove sections which contain
1167 information that is not needed by the binary file.
1169 Note---@command{objcopy} is not able to change the endianness of its input
1170 files. If the input format has an endianness (some formats do not),
1171 @command{objcopy} can only copy the inputs into file formats that have the
1172 same endianness or which have no endianness (e.g., @samp{srec}).
1173 (However, see the @option{--reverse-bytes} option.)
1177 @c man begin OPTIONS objcopy
1181 @itemx @var{outfile}
1182 The input and output files, respectively.
1183 If you do not specify @var{outfile}, @command{objcopy} creates a
1184 temporary file and destructively renames the result with
1185 the name of @var{infile}.
1187 @item -I @var{bfdname}
1188 @itemx --input-target=@var{bfdname}
1189 Consider the source file's object format to be @var{bfdname}, rather than
1190 attempting to deduce it. @xref{Target Selection}, for more information.
1192 @item -O @var{bfdname}
1193 @itemx --output-target=@var{bfdname}
1194 Write the output file using the object format @var{bfdname}.
1195 @xref{Target Selection}, for more information.
1197 @item -F @var{bfdname}
1198 @itemx --target=@var{bfdname}
1199 Use @var{bfdname} as the object format for both the input and the output
1200 file; i.e., simply transfer data from source to destination with no
1201 translation. @xref{Target Selection}, for more information.
1203 @item -B @var{bfdarch}
1204 @itemx --binary-architecture=@var{bfdarch}
1205 Useful when transforming a architecture-less input file into an object file.
1206 In this case the output architecture can be set to @var{bfdarch}. This
1207 option will be ignored if the input file has a known @var{bfdarch}. You
1208 can access this binary data inside a program by referencing the special
1209 symbols that are created by the conversion process. These symbols are
1210 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1211 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1212 an object file and then access it in your code using these symbols.
1214 @item -j @var{sectionpattern}
1215 @itemx --only-section=@var{sectionpattern}
1216 Copy only the indicated sections from the input file to the output file.
1217 This option may be given more than once. Note that using this option
1218 inappropriately may make the output file unusable. Wildcard
1219 characters are accepted in @var{sectionpattern}.
1221 @item -R @var{sectionpattern}
1222 @itemx --remove-section=@var{sectionpattern}
1223 Remove any section matching @var{sectionpattern} from the output file.
1224 This option may be given more than once. Note that using this option
1225 inappropriately may make the output file unusable. Wildcard
1226 characters are accepted in @var{sectionpattern}. Using both the
1227 @option{-j} and @option{-R} options together results in undefined
1232 Do not copy relocation and symbol information from the source file.
1235 @itemx --strip-debug
1236 Do not copy debugging symbols or sections from the source file.
1238 @item --strip-unneeded
1239 Strip all symbols that are not needed for relocation processing.
1241 @item -K @var{symbolname}
1242 @itemx --keep-symbol=@var{symbolname}
1243 When stripping symbols, keep symbol @var{symbolname} even if it would
1244 normally be stripped. This option may be given more than once.
1246 @item -N @var{symbolname}
1247 @itemx --strip-symbol=@var{symbolname}
1248 Do not copy symbol @var{symbolname} from the source file. This option
1249 may be given more than once.
1251 @item --strip-unneeded-symbol=@var{symbolname}
1252 Do not copy symbol @var{symbolname} from the source file unless it is needed
1253 by a relocation. This option may be given more than once.
1255 @item -G @var{symbolname}
1256 @itemx --keep-global-symbol=@var{symbolname}
1257 Keep only symbol @var{symbolname} global. Make all other symbols local
1258 to the file, so that they are not visible externally. This option may
1259 be given more than once.
1261 @item --localize-hidden
1262 In an ELF object, mark all symbols that have hidden or internal visibility
1263 as local. This option applies on top of symbol-specific localization options
1264 such as @option{-L}.
1266 @item -L @var{symbolname}
1267 @itemx --localize-symbol=@var{symbolname}
1268 Make symbol @var{symbolname} local to the file, so that it is not
1269 visible externally. This option may be given more than once.
1271 @item -W @var{symbolname}
1272 @itemx --weaken-symbol=@var{symbolname}
1273 Make symbol @var{symbolname} weak. This option may be given more than once.
1275 @item --globalize-symbol=@var{symbolname}
1276 Give symbol @var{symbolname} global scoping so that it is visible
1277 outside of the file in which it is defined. This option may be given
1282 Permit regular expressions in @var{symbolname}s used in other command
1283 line options. The question mark (?), asterisk (*), backslash (\) and
1284 square brackets ([]) operators can be used anywhere in the symbol
1285 name. If the first character of the symbol name is the exclamation
1286 point (!) then the sense of the switch is reversed for that symbol.
1293 would cause objcopy to weaken all symbols that start with ``fo''
1294 except for the symbol ``foo''.
1297 @itemx --discard-all
1298 Do not copy non-global symbols from the source file.
1299 @c FIXME any reason to prefer "non-global" to "local" here?
1302 @itemx --discard-locals
1303 Do not copy compiler-generated local symbols.
1304 (These usually start with @samp{L} or @samp{.}.)
1307 @itemx --byte=@var{byte}
1308 If interleaving has been enabled via the @option{--interleave} option
1309 then start the range of bytes to keep at the @var{byte}th byte.
1310 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1311 @var{breadth} is the value given by the @option{--interleave} option.
1313 @item -i [@var{breadth}]
1314 @itemx --interleave[=@var{breadth}]
1315 Only copy a range out of every @var{breadth} bytes. (Header data is
1316 not affected). Select which byte in the range begins the copy with
1317 the @option{--byte} option. Select the width of the range with the
1318 @option{--interleave-width} option.
1320 This option is useful for creating files to program @sc{rom}. It is
1321 typically used with an @code{srec} output target. Note that
1322 @command{objcopy} will complain if you do not specify the
1323 @option{--byte} option as well.
1325 The default interleave breadth is 4, so with @option{--byte} set to 0,
1326 @command{objcopy} would copy the first byte out of every four bytes
1327 from the input to the output.
1329 @item --interleave-width=@var{width}
1330 When used with the @option{--interleave} option, copy @var{width}
1331 bytes at a time. The start of the range of bytes to be copied is set
1332 by the @option{--byte} option, and the extent of the range is set with
1333 the @option{--interleave} option.
1335 The default value for this option is 1. The value of @var{width} plus
1336 the @var{byte} value set by the @option{--byte} option must not exceed
1337 the interleave breadth set by the @option{--interleave} option.
1339 This option can be used to create images for two 16-bit flashes interleaved
1340 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1341 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1342 commands. If the input was '12345678' then the outputs would be
1343 '1256' and '3478' respectively.
1346 @itemx --preserve-dates
1347 Set the access and modification dates of the output file to be the same
1348 as those of the input file.
1351 @itemx --enable-deterministic-archives
1352 @cindex deterministic archives
1353 @kindex --enable-deterministic-archives
1354 Operate in @emph{deterministic} mode. When copying archive members
1355 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1356 and use consistent file modes for all files.
1358 If @file{binutils} was configured with
1359 @option{--enable-deterministic-archives}, then this mode is on by default.
1360 It can be disabled with the @samp{-U} option, below.
1363 @itemx --disable-deterministic-archives
1364 @cindex deterministic archives
1365 @kindex --enable-deterministic-archives
1366 Do @emph{not} operate in @emph{deterministic} mode. This is the
1367 inverse of the @option{-D} option, above: when copying archive members
1368 and writing the archive index, use their actual UID, GID, timestamp,
1369 and file mode values.
1371 This is the default unless @file{binutils} was configured with
1372 @option{--enable-deterministic-archives}.
1375 Convert debugging information, if possible. This is not the default
1376 because only certain debugging formats are supported, and the
1377 conversion process can be time consuming.
1379 @item --gap-fill @var{val}
1380 Fill gaps between sections with @var{val}. This operation applies to
1381 the @emph{load address} (LMA) of the sections. It is done by increasing
1382 the size of the section with the lower address, and filling in the extra
1383 space created with @var{val}.
1385 @item --pad-to @var{address}
1386 Pad the output file up to the load address @var{address}. This is
1387 done by increasing the size of the last section. The extra space is
1388 filled in with the value specified by @option{--gap-fill} (default zero).
1390 @item --set-start @var{val}
1391 Set the start address of the new file to @var{val}. Not all object file
1392 formats support setting the start address.
1394 @item --change-start @var{incr}
1395 @itemx --adjust-start @var{incr}
1396 @cindex changing start address
1397 Change the start address by adding @var{incr}. Not all object file
1398 formats support setting the start address.
1400 @item --change-addresses @var{incr}
1401 @itemx --adjust-vma @var{incr}
1402 @cindex changing object addresses
1403 Change the VMA and LMA addresses of all sections, as well as the start
1404 address, by adding @var{incr}. Some object file formats do not permit
1405 section addresses to be changed arbitrarily. Note that this does not
1406 relocate the sections; if the program expects sections to be loaded at a
1407 certain address, and this option is used to change the sections such
1408 that they are loaded at a different address, the program may fail.
1410 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1411 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1412 @cindex changing section address
1413 Set or change both the VMA address and the LMA address of any section
1414 matching @var{sectionpattern}. If @samp{=} is used, the section
1415 address is set to @var{val}. Otherwise, @var{val} is added to or
1416 subtracted from the section address. See the comments under
1417 @option{--change-addresses}, above. If @var{sectionpattern} does not
1418 match any sections in the input file, a warning will be issued, unless
1419 @option{--no-change-warnings} is used.
1421 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1422 @cindex changing section LMA
1423 Set or change the LMA address of any sections matching
1424 @var{sectionpattern}. The LMA address is the address where the
1425 section will be loaded into memory at program load time. Normally
1426 this is the same as the VMA address, which is the address of the
1427 section at program run time, but on some systems, especially those
1428 where a program is held in ROM, the two can be different. If @samp{=}
1429 is used, the section address is set to @var{val}. Otherwise,
1430 @var{val} is added to or subtracted from the section address. See the
1431 comments under @option{--change-addresses}, above. If
1432 @var{sectionpattern} does not match any sections in the input file, a
1433 warning will be issued, unless @option{--no-change-warnings} is used.
1435 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1436 @cindex changing section VMA
1437 Set or change the VMA address of any section matching
1438 @var{sectionpattern}. The VMA address is the address where the
1439 section will be located once the program has started executing.
1440 Normally this is the same as the LMA address, which is the address
1441 where the section will be loaded into memory, but on some systems,
1442 especially those where a program is held in ROM, the two can be
1443 different. If @samp{=} is used, the section address is set to
1444 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1445 section address. See the comments under @option{--change-addresses},
1446 above. If @var{sectionpattern} does not match any sections in the
1447 input file, a warning will be issued, unless
1448 @option{--no-change-warnings} is used.
1450 @item --change-warnings
1451 @itemx --adjust-warnings
1452 If @option{--change-section-address} or @option{--change-section-lma} or
1453 @option{--change-section-vma} is used, and the section pattern does not
1454 match any sections, issue a warning. This is the default.
1456 @item --no-change-warnings
1457 @itemx --no-adjust-warnings
1458 Do not issue a warning if @option{--change-section-address} or
1459 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1460 if the section pattern does not match any sections.
1462 @item --set-section-flags @var{sectionpattern}=@var{flags}
1463 Set the flags for any sections matching @var{sectionpattern}. The
1464 @var{flags} argument is a comma separated string of flag names. The
1465 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1466 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1467 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1468 for a section which does not have contents, but it is not meaningful
1469 to clear the @samp{contents} flag of a section which does have
1470 contents--just remove the section instead. Not all flags are
1471 meaningful for all object file formats.
1473 @item --add-section @var{sectionname}=@var{filename}
1474 Add a new section named @var{sectionname} while copying the file. The
1475 contents of the new section are taken from the file @var{filename}. The
1476 size of the section will be the size of the file. This option only
1477 works on file formats which can support sections with arbitrary names.
1479 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1480 Rename a section from @var{oldname} to @var{newname}, optionally
1481 changing the section's flags to @var{flags} in the process. This has
1482 the advantage over usng a linker script to perform the rename in that
1483 the output stays as an object file and does not become a linked
1486 This option is particularly helpful when the input format is binary,
1487 since this will always create a section called .data. If for example,
1488 you wanted instead to create a section called .rodata containing binary
1489 data you could use the following command line to achieve it:
1492 objcopy -I binary -O <output_format> -B <architecture> \
1493 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1494 <input_binary_file> <output_object_file>
1497 @item --long-section-names @{enable,disable,keep@}
1498 Controls the handling of long section names when processing @code{COFF}
1499 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1500 is to preserve long section names if any are present in the input file.
1501 The @samp{enable} and @samp{disable} options forcibly enable or disable
1502 the use of long section names in the output object; when @samp{disable}
1503 is in effect, any long section names in the input object will be truncated.
1504 The @samp{enable} option will only emit long section names if any are
1505 present in the inputs; this is mostly the same as @samp{keep}, but it
1506 is left undefined whether the @samp{enable} option might force the
1507 creation of an empty string table in the output file.
1509 @item --change-leading-char
1510 Some object file formats use special characters at the start of
1511 symbols. The most common such character is underscore, which compilers
1512 often add before every symbol. This option tells @command{objcopy} to
1513 change the leading character of every symbol when it converts between
1514 object file formats. If the object file formats use the same leading
1515 character, this option has no effect. Otherwise, it will add a
1516 character, or remove a character, or change a character, as
1519 @item --remove-leading-char
1520 If the first character of a global symbol is a special symbol leading
1521 character used by the object file format, remove the character. The
1522 most common symbol leading character is underscore. This option will
1523 remove a leading underscore from all global symbols. This can be useful
1524 if you want to link together objects of different file formats with
1525 different conventions for symbol names. This is different from
1526 @option{--change-leading-char} because it always changes the symbol name
1527 when appropriate, regardless of the object file format of the output
1530 @item --reverse-bytes=@var{num}
1531 Reverse the bytes in a section with output contents. A section length must
1532 be evenly divisible by the value given in order for the swap to be able to
1533 take place. Reversing takes place before the interleaving is performed.
1535 This option is used typically in generating ROM images for problematic
1536 target systems. For example, on some target boards, the 32-bit words
1537 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1538 regardless of the CPU byte order. Depending on the programming model, the
1539 endianness of the ROM may need to be modified.
1541 Consider a simple file with a section containing the following eight
1542 bytes: @code{12345678}.
1544 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1545 output file would be ordered @code{21436587}.
1547 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1548 output file would be ordered @code{43218765}.
1550 By using @samp{--reverse-bytes=2} for the above example, followed by
1551 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1552 output file would be ordered @code{34127856}.
1554 @item --srec-len=@var{ival}
1555 Meaningful only for srec output. Set the maximum length of the Srecords
1556 being produced to @var{ival}. This length covers both address, data and
1559 @item --srec-forceS3
1560 Meaningful only for srec output. Avoid generation of S1/S2 records,
1561 creating S3-only record format.
1563 @item --redefine-sym @var{old}=@var{new}
1564 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1565 when one is trying link two things together for which you have no
1566 source, and there are name collisions.
1568 @item --redefine-syms=@var{filename}
1569 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1570 listed in the file @var{filename}. @var{filename} is simply a flat file,
1571 with one symbol pair per line. Line comments may be introduced by the hash
1572 character. This option may be given more than once.
1575 Change all global symbols in the file to be weak. This can be useful
1576 when building an object which will be linked against other objects using
1577 the @option{-R} option to the linker. This option is only effective when
1578 using an object file format which supports weak symbols.
1580 @item --keep-symbols=@var{filename}
1581 Apply @option{--keep-symbol} option to each symbol listed in the file
1582 @var{filename}. @var{filename} is simply a flat file, with one symbol
1583 name per line. Line comments may be introduced by the hash character.
1584 This option may be given more than once.
1586 @item --strip-symbols=@var{filename}
1587 Apply @option{--strip-symbol} option to each symbol listed in the file
1588 @var{filename}. @var{filename} is simply a flat file, with one symbol
1589 name per line. Line comments may be introduced by the hash character.
1590 This option may be given more than once.
1592 @item --strip-unneeded-symbols=@var{filename}
1593 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1594 the file @var{filename}. @var{filename} is simply a flat file, with one
1595 symbol name per line. Line comments may be introduced by the hash
1596 character. This option may be given more than once.
1598 @item --keep-global-symbols=@var{filename}
1599 Apply @option{--keep-global-symbol} option to each symbol listed in the
1600 file @var{filename}. @var{filename} is simply a flat file, with one
1601 symbol name per line. Line comments may be introduced by the hash
1602 character. This option may be given more than once.
1604 @item --localize-symbols=@var{filename}
1605 Apply @option{--localize-symbol} option to each symbol listed in the file
1606 @var{filename}. @var{filename} is simply a flat file, with one symbol
1607 name per line. Line comments may be introduced by the hash character.
1608 This option may be given more than once.
1610 @item --globalize-symbols=@var{filename}
1611 Apply @option{--globalize-symbol} option to each symbol listed in the file
1612 @var{filename}. @var{filename} is simply a flat file, with one symbol
1613 name per line. Line comments may be introduced by the hash character.
1614 This option may be given more than once.
1616 @item --weaken-symbols=@var{filename}
1617 Apply @option{--weaken-symbol} option to each symbol listed in the file
1618 @var{filename}. @var{filename} is simply a flat file, with one symbol
1619 name per line. Line comments may be introduced by the hash character.
1620 This option may be given more than once.
1622 @item --alt-machine-code=@var{index}
1623 If the output architecture has alternate machine codes, use the
1624 @var{index}th code instead of the default one. This is useful in case
1625 a machine is assigned an official code and the tool-chain adopts the
1626 new code, but other applications still depend on the original code
1627 being used. For ELF based architectures if the @var{index}
1628 alternative does not exist then the value is treated as an absolute
1629 number to be stored in the e_machine field of the ELF header.
1631 @item --writable-text
1632 Mark the output text as writable. This option isn't meaningful for all
1633 object file formats.
1635 @item --readonly-text
1636 Make the output text write protected. This option isn't meaningful for all
1637 object file formats.
1640 Mark the output file as demand paged. This option isn't meaningful for all
1641 object file formats.
1644 Mark the output file as impure. This option isn't meaningful for all
1645 object file formats.
1647 @item --prefix-symbols=@var{string}
1648 Prefix all symbols in the output file with @var{string}.
1650 @item --prefix-sections=@var{string}
1651 Prefix all section names in the output file with @var{string}.
1653 @item --prefix-alloc-sections=@var{string}
1654 Prefix all the names of all allocated sections in the output file with
1657 @item --add-gnu-debuglink=@var{path-to-file}
1658 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1659 and adds it to the output file.
1661 @item --keep-file-symbols
1662 When stripping a file, perhaps with @option{--strip-debug} or
1663 @option{--strip-unneeded}, retain any symbols specifying source file names,
1664 which would otherwise get stripped.
1666 @item --only-keep-debug
1667 Strip a file, removing contents of any sections that would not be
1668 stripped by @option{--strip-debug} and leaving the debugging sections
1669 intact. In ELF files, this preserves all note sections in the output.
1671 The intention is that this option will be used in conjunction with
1672 @option{--add-gnu-debuglink} to create a two part executable. One a
1673 stripped binary which will occupy less space in RAM and in a
1674 distribution and the second a debugging information file which is only
1675 needed if debugging abilities are required. The suggested procedure
1676 to create these files is as follows:
1679 @item Link the executable as normal. Assuming that is is called
1681 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1682 create a file containing the debugging info.
1683 @item Run @code{objcopy --strip-debug foo} to create a
1684 stripped executable.
1685 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1686 to add a link to the debugging info into the stripped executable.
1689 Note---the choice of @code{.dbg} as an extension for the debug info
1690 file is arbitrary. Also the @code{--only-keep-debug} step is
1691 optional. You could instead do this:
1694 @item Link the executable as normal.
1695 @item Copy @code{foo} to @code{foo.full}
1696 @item Run @code{objcopy --strip-debug foo}
1697 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1700 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1701 full executable. It does not have to be a file created by the
1702 @option{--only-keep-debug} switch.
1704 Note---this switch is only intended for use on fully linked files. It
1705 does not make sense to use it on object files where the debugging
1706 information may be incomplete. Besides the gnu_debuglink feature
1707 currently only supports the presence of one filename containing
1708 debugging information, not multiple filenames on a one-per-object-file
1712 Remove the contents of all DWARF .dwo sections, leaving the
1713 remaining debugging sections and all symbols intact.
1714 This option is intended for use by the compiler as part of
1715 the @option{-gsplit-dwarf} option, which splits debug information
1716 between the .o file and a separate .dwo file. The compiler
1717 generates all debug information in the same file, then uses
1718 the @option{--extract-dwo} option to copy the .dwo sections to
1719 the .dwo file, then the @option{--strip-dwo} option to remove
1720 those sections from the original .o file.
1723 Extract the contents of all DWARF .dwo sections. See the
1724 @option{--strip-dwo} option for more information.
1726 @item --file-alignment @var{num}
1727 Specify the file alignment. Sections in the file will always begin at
1728 file offsets which are multiples of this number. This defaults to
1730 [This option is specific to PE targets.]
1732 @item --heap @var{reserve}
1733 @itemx --heap @var{reserve},@var{commit}
1734 Specify the number of bytes of memory to reserve (and optionally commit)
1735 to be used as heap for this program.
1736 [This option is specific to PE targets.]
1738 @item --image-base @var{value}
1739 Use @var{value} as the base address of your program or dll. This is
1740 the lowest memory location that will be used when your program or dll
1741 is loaded. To reduce the need to relocate and improve performance of
1742 your dlls, each should have a unique base address and not overlap any
1743 other dlls. The default is 0x400000 for executables, and 0x10000000
1745 [This option is specific to PE targets.]
1747 @item --section-alignment @var{num}
1748 Sets the section alignment. Sections in memory will always begin at
1749 addresses which are a multiple of this number. Defaults to 0x1000.
1750 [This option is specific to PE targets.]
1752 @item --stack @var{reserve}
1753 @itemx --stack @var{reserve},@var{commit}
1754 Specify the number of bytes of memory to reserve (and optionally commit)
1755 to be used as stack for this program.
1756 [This option is specific to PE targets.]
1758 @item --subsystem @var{which}
1759 @itemx --subsystem @var{which}:@var{major}
1760 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1761 Specifies the subsystem under which your program will execute. The
1762 legal values for @var{which} are @code{native}, @code{windows},
1763 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1764 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1765 the subsystem version also. Numeric values are also accepted for
1767 [This option is specific to PE targets.]
1769 @item --extract-symbol
1770 Keep the file's section flags and symbols but remove all section data.
1771 Specifically, the option:
1774 @item removes the contents of all sections;
1775 @item sets the size of every section to zero; and
1776 @item sets the file's start address to zero.
1779 This option is used to build a @file{.sym} file for a VxWorks kernel.
1780 It can also be a useful way of reducing the size of a @option{--just-symbols}
1783 @item --compress-debug-sections
1784 Compress DWARF debug sections using zlib.
1786 @item --decompress-debug-sections
1787 Decompress DWARF debug sections using zlib.
1791 Show the version number of @command{objcopy}.
1795 Verbose output: list all object files modified. In the case of
1796 archives, @samp{objcopy -V} lists all members of the archive.
1799 Show a summary of the options to @command{objcopy}.
1802 Display a list showing all architectures and object formats available.
1808 @c man begin SEEALSO objcopy
1809 ld(1), objdump(1), and the Info entries for @file{binutils}.
1816 @cindex object file information
1819 @c man title objdump display information from object files.
1822 @c man begin SYNOPSIS objdump
1823 objdump [@option{-a}|@option{--archive-headers}]
1824 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1825 [@option{-C}|@option{--demangle}[=@var{style}] ]
1826 [@option{-d}|@option{--disassemble}]
1827 [@option{-D}|@option{--disassemble-all}]
1828 [@option{-z}|@option{--disassemble-zeroes}]
1829 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1830 [@option{-f}|@option{--file-headers}]
1831 [@option{-F}|@option{--file-offsets}]
1832 [@option{--file-start-context}]
1833 [@option{-g}|@option{--debugging}]
1834 [@option{-e}|@option{--debugging-tags}]
1835 [@option{-h}|@option{--section-headers}|@option{--headers}]
1836 [@option{-i}|@option{--info}]
1837 [@option{-j} @var{section}|@option{--section=}@var{section}]
1838 [@option{-l}|@option{--line-numbers}]
1839 [@option{-S}|@option{--source}]
1840 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1841 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1842 [@option{-p}|@option{--private-headers}]
1843 [@option{-P} @var{options}|@option{--private=}@var{options}]
1844 [@option{-r}|@option{--reloc}]
1845 [@option{-R}|@option{--dynamic-reloc}]
1846 [@option{-s}|@option{--full-contents}]
1847 [@option{-W[lLiaprmfFsoRt]}|
1848 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
1849 [@option{-G}|@option{--stabs}]
1850 [@option{-t}|@option{--syms}]
1851 [@option{-T}|@option{--dynamic-syms}]
1852 [@option{-x}|@option{--all-headers}]
1853 [@option{-w}|@option{--wide}]
1854 [@option{--start-address=}@var{address}]
1855 [@option{--stop-address=}@var{address}]
1856 [@option{--prefix-addresses}]
1857 [@option{--[no-]show-raw-insn}]
1858 [@option{--adjust-vma=}@var{offset}]
1859 [@option{--special-syms}]
1860 [@option{--prefix=}@var{prefix}]
1861 [@option{--prefix-strip=}@var{level}]
1862 [@option{--insn-width=}@var{width}]
1863 [@option{-V}|@option{--version}]
1864 [@option{-H}|@option{--help}]
1865 @var{objfile}@dots{}
1869 @c man begin DESCRIPTION objdump
1871 @command{objdump} displays information about one or more object files.
1872 The options control what particular information to display. This
1873 information is mostly useful to programmers who are working on the
1874 compilation tools, as opposed to programmers who just want their
1875 program to compile and work.
1877 @var{objfile}@dots{} are the object files to be examined. When you
1878 specify archives, @command{objdump} shows information on each of the member
1883 @c man begin OPTIONS objdump
1885 The long and short forms of options, shown here as alternatives, are
1886 equivalent. At least one option from the list
1887 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1891 @itemx --archive-header
1892 @cindex archive headers
1893 If any of the @var{objfile} files are archives, display the archive
1894 header information (in a format similar to @samp{ls -l}). Besides the
1895 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1896 the object file format of each archive member.
1898 @item --adjust-vma=@var{offset}
1899 @cindex section addresses in objdump
1900 @cindex VMA in objdump
1901 When dumping information, first add @var{offset} to all the section
1902 addresses. This is useful if the section addresses do not correspond to
1903 the symbol table, which can happen when putting sections at particular
1904 addresses when using a format which can not represent section addresses,
1907 @item -b @var{bfdname}
1908 @itemx --target=@var{bfdname}
1909 @cindex object code format
1910 Specify that the object-code format for the object files is
1911 @var{bfdname}. This option may not be necessary; @var{objdump} can
1912 automatically recognize many formats.
1916 objdump -b oasys -m vax -h fu.o
1919 displays summary information from the section headers (@option{-h}) of
1920 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1921 file in the format produced by Oasys compilers. You can list the
1922 formats available with the @option{-i} option.
1923 @xref{Target Selection}, for more information.
1926 @itemx --demangle[=@var{style}]
1927 @cindex demangling in objdump
1928 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1929 Besides removing any initial underscore prepended by the system, this
1930 makes C++ function names readable. Different compilers have different
1931 mangling styles. The optional demangling style argument can be used to
1932 choose an appropriate demangling style for your compiler. @xref{c++filt},
1933 for more information on demangling.
1937 Display debugging information. This attempts to parse STABS and IEEE
1938 debugging format information stored in the file and print it out using
1939 a C like syntax. If neither of these formats are found this option
1940 falls back on the @option{-W} option to print any DWARF information in
1944 @itemx --debugging-tags
1945 Like @option{-g}, but the information is generated in a format compatible
1949 @itemx --disassemble
1950 @cindex disassembling object code
1951 @cindex machine instructions
1952 Display the assembler mnemonics for the machine instructions from
1953 @var{objfile}. This option only disassembles those sections which are
1954 expected to contain instructions.
1957 @itemx --disassemble-all
1958 Like @option{-d}, but disassemble the contents of all sections, not just
1959 those expected to contain instructions.
1961 If the target is an ARM architecture this switch also has the effect
1962 of forcing the disassembler to decode pieces of data found in code
1963 sections as if they were instructions.
1965 @item --prefix-addresses
1966 When disassembling, print the complete address on each line. This is
1967 the older disassembly format.
1971 @itemx --endian=@{big|little@}
1973 @cindex disassembly endianness
1974 Specify the endianness of the object files. This only affects
1975 disassembly. This can be useful when disassembling a file format which
1976 does not describe endianness information, such as S-records.
1979 @itemx --file-headers
1980 @cindex object file header
1981 Display summary information from the overall header of
1982 each of the @var{objfile} files.
1985 @itemx --file-offsets
1986 @cindex object file offsets
1987 When disassembling sections, whenever a symbol is displayed, also
1988 display the file offset of the region of data that is about to be
1989 dumped. If zeroes are being skipped, then when disassembly resumes,
1990 tell the user how many zeroes were skipped and the file offset of the
1991 location from where the disassembly resumes. When dumping sections,
1992 display the file offset of the location from where the dump starts.
1994 @item --file-start-context
1995 @cindex source code context
1996 Specify that when displaying interlisted source code/disassembly
1997 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1998 context to the start of the file.
2001 @itemx --section-headers
2003 @cindex section headers
2004 Display summary information from the section headers of the
2007 File segments may be relocated to nonstandard addresses, for example by
2008 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2009 @command{ld}. However, some object file formats, such as a.out, do not
2010 store the starting address of the file segments. In those situations,
2011 although @command{ld} relocates the sections correctly, using @samp{objdump
2012 -h} to list the file section headers cannot show the correct addresses.
2013 Instead, it shows the usual addresses, which are implicit for the
2018 Print a summary of the options to @command{objdump} and exit.
2022 @cindex architectures available
2023 @cindex object formats available
2024 Display a list showing all architectures and object formats available
2025 for specification with @option{-b} or @option{-m}.
2028 @itemx --section=@var{name}
2029 @cindex section information
2030 Display information only for section @var{name}.
2033 @itemx --line-numbers
2034 @cindex source filenames for object files
2035 Label the display (using debugging information) with the filename and
2036 source line numbers corresponding to the object code or relocs shown.
2037 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2039 @item -m @var{machine}
2040 @itemx --architecture=@var{machine}
2041 @cindex architecture
2042 @cindex disassembly architecture
2043 Specify the architecture to use when disassembling object files. This
2044 can be useful when disassembling object files which do not describe
2045 architecture information, such as S-records. You can list the available
2046 architectures with the @option{-i} option.
2048 If the target is an ARM architecture then this switch has an
2049 additional effect. It restricts the disassembly to only those
2050 instructions supported by the architecture specified by @var{machine}.
2051 If it is necessary to use this switch because the input file does not
2052 contain any architecture information, but it is also desired to
2053 disassemble all the instructions use @option{-marm}.
2055 @item -M @var{options}
2056 @itemx --disassembler-options=@var{options}
2057 Pass target specific information to the disassembler. Only supported on
2058 some targets. If it is necessary to specify more than one
2059 disassembler option then multiple @option{-M} options can be used or
2060 can be placed together into a comma separated list.
2062 If the target is an ARM architecture then this switch can be used to
2063 select which register name set is used during disassembler. Specifying
2064 @option{-M reg-names-std} (the default) will select the register names as
2065 used in ARM's instruction set documentation, but with register 13 called
2066 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2067 @option{-M reg-names-apcs} will select the name set used by the ARM
2068 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2069 just use @samp{r} followed by the register number.
2071 There are also two variants on the APCS register naming scheme enabled
2072 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2073 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2074 with the normal register names or the special register names).
2076 This option can also be used for ARM architectures to force the
2077 disassembler to interpret all instructions as Thumb instructions by
2078 using the switch @option{--disassembler-options=force-thumb}. This can be
2079 useful when attempting to disassemble thumb code produced by other
2082 For the x86, some of the options duplicate functions of the @option{-m}
2083 switch, but allow finer grained control. Multiple selections from the
2084 following may be specified as a comma separated string.
2085 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
2086 the given architecture. @option{intel} and @option{att} select between
2087 intel syntax mode and AT&T syntax mode.
2088 @option{intel-mnemonic} and @option{att-mnemonic} select between
2089 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
2090 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
2091 @option{addr64}, @option{addr32},
2092 @option{addr16}, @option{data32} and @option{data16} specify the default
2093 address size and operand size. These four options will be overridden if
2094 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
2095 option string. Lastly, @option{suffix}, when in AT&T mode,
2096 instructs the disassembler to print a mnemonic suffix even when the
2097 suffix could be inferred by the operands.
2099 For PowerPC, @option{booke} controls the disassembly of BookE
2100 instructions. @option{32} and @option{64} select PowerPC and
2101 PowerPC64 disassembly, respectively. @option{e300} selects
2102 disassembly for the e300 family. @option{440} selects disassembly for
2103 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2104 single instructions of the PPC750CL.
2106 For MIPS, this option controls the printing of instruction mnemonic
2107 names and register names in disassembled instructions. Multiple
2108 selections from the following may be specified as a comma separated
2109 string, and invalid options are ignored:
2113 Print the 'raw' instruction mnemonic instead of some pseudo
2114 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2115 'sll' instead of 'nop', etc.
2118 Disassemble the virtualization ASE instructions.
2120 @item gpr-names=@var{ABI}
2121 Print GPR (general-purpose register) names as appropriate
2122 for the specified ABI. By default, GPR names are selected according to
2123 the ABI of the binary being disassembled.
2125 @item fpr-names=@var{ABI}
2126 Print FPR (floating-point register) names as
2127 appropriate for the specified ABI. By default, FPR numbers are printed
2130 @item cp0-names=@var{ARCH}
2131 Print CP0 (system control coprocessor; coprocessor 0) register names
2132 as appropriate for the CPU or architecture specified by
2133 @var{ARCH}. By default, CP0 register names are selected according to
2134 the architecture and CPU of the binary being disassembled.
2136 @item hwr-names=@var{ARCH}
2137 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2138 as appropriate for the CPU or architecture specified by
2139 @var{ARCH}. By default, HWR names are selected according to
2140 the architecture and CPU of the binary being disassembled.
2142 @item reg-names=@var{ABI}
2143 Print GPR and FPR names as appropriate for the selected ABI.
2145 @item reg-names=@var{ARCH}
2146 Print CPU-specific register names (CP0 register and HWR names)
2147 as appropriate for the selected CPU or architecture.
2150 For any of the options listed above, @var{ABI} or
2151 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2152 rather than names, for the selected types of registers.
2153 You can list the available values of @var{ABI} and @var{ARCH} using
2154 the @option{--help} option.
2156 For VAX, you can specify function entry addresses with @option{-M
2157 entry:0xf00ba}. You can use this multiple times to properly
2158 disassemble VAX binary files that don't contain symbol tables (like
2159 ROM dumps). In these cases, the function entry mask would otherwise
2160 be decoded as VAX instructions, which would probably lead the rest
2161 of the function being wrongly disassembled.
2164 @itemx --private-headers
2165 Print information that is specific to the object file format. The exact
2166 information printed depends upon the object file format. For some
2167 object file formats, no additional information is printed.
2169 @item -P @var{options}
2170 @itemx --private=@var{options}
2171 Print information that is specific to the object file format. The
2172 argument @var{options} is a comma separated list that depends on the
2173 format (the lists of options is displayed with the help).
2175 For XCOFF, the available options are: @option{header}, @option{aout},
2176 @option{sections}, @option{syms}, @option{relocs}, @option{lineno},
2177 @option{loader}, @option{except}, @option{typchk}, @option{traceback},
2178 @option{toc} and @option{ldinfo}.
2182 @cindex relocation entries, in object file
2183 Print the relocation entries of the file. If used with @option{-d} or
2184 @option{-D}, the relocations are printed interspersed with the
2188 @itemx --dynamic-reloc
2189 @cindex dynamic relocation entries, in object file
2190 Print the dynamic relocation entries of the file. This is only
2191 meaningful for dynamic objects, such as certain types of shared
2192 libraries. As for @option{-r}, if used with @option{-d} or
2193 @option{-D}, the relocations are printed interspersed with the
2197 @itemx --full-contents
2198 @cindex sections, full contents
2199 @cindex object file sections
2200 Display the full contents of any sections requested. By default all
2201 non-empty sections are displayed.
2205 @cindex source disassembly
2206 @cindex disassembly, with source
2207 Display source code intermixed with disassembly, if possible. Implies
2210 @item --prefix=@var{prefix}
2211 @cindex Add prefix to absolute paths
2212 Specify @var{prefix} to add to the absolute paths when used with
2215 @item --prefix-strip=@var{level}
2216 @cindex Strip absolute paths
2217 Indicate how many initial directory names to strip off the hardwired
2218 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2220 @item --show-raw-insn
2221 When disassembling instructions, print the instruction in hex as well as
2222 in symbolic form. This is the default except when
2223 @option{--prefix-addresses} is used.
2225 @item --no-show-raw-insn
2226 When disassembling instructions, do not print the instruction bytes.
2227 This is the default when @option{--prefix-addresses} is used.
2229 @item --insn-width=@var{width}
2230 @cindex Instruction width
2231 Display @var{width} bytes on a single line when disassembling
2234 @item -W[lLiaprmfFsoRt]
2235 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
2237 @cindex debug symbols
2238 Displays the contents of the debug sections in the file, if any are
2239 present. If one of the optional letters or words follows the switch
2240 then only data found in those specific sections will be dumped.
2242 Note that there is no single letter option to display the content of
2243 trace sections or .gdb_index.
2245 Note: the output from the @option{=info} option can also be affected
2246 by the options @option{--dwarf-depth}, the @option{--dwarf-start} and
2247 the @option{--dwarf-check}.
2249 @item --dwarf-depth=@var{n}
2250 Limit the dump of the @code{.debug_info} section to @var{n} children.
2251 This is only useful with @option{--dwarf=info}. The default is
2252 to print all DIEs; the special value 0 for @var{n} will also have this
2255 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2256 levels will not be printed. The range for @var{n} is zero-based.
2258 @item --dwarf-start=@var{n}
2259 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2260 useful with @option{--dwarf=info}.
2262 If specified, this option will suppress printing of any header
2263 information and all DIEs before the DIE numbered @var{n}. Only
2264 siblings and children of the specified DIE will be printed.
2266 This can be used in conjunction with @option{--dwarf-depth}.
2269 Enable additional checks for consistency of Dwarf information.
2275 @cindex debug symbols
2276 @cindex ELF object file format
2277 Display the full contents of any sections requested. Display the
2278 contents of the .stab and .stab.index and .stab.excl sections from an
2279 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2280 @code{.stab} debugging symbol-table entries are carried in an ELF
2281 section. In most other file formats, debugging symbol-table entries are
2282 interleaved with linkage symbols, and are visible in the @option{--syms}
2285 @item --start-address=@var{address}
2286 @cindex start-address
2287 Start displaying data at the specified address. This affects the output
2288 of the @option{-d}, @option{-r} and @option{-s} options.
2290 @item --stop-address=@var{address}
2291 @cindex stop-address
2292 Stop displaying data at the specified address. This affects the output
2293 of the @option{-d}, @option{-r} and @option{-s} options.
2297 @cindex symbol table entries, printing
2298 Print the symbol table entries of the file.
2299 This is similar to the information provided by the @samp{nm} program,
2300 although the display format is different. The format of the output
2301 depends upon the format of the file being dumped, but there are two main
2302 types. One looks like this:
2305 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2306 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2309 where the number inside the square brackets is the number of the entry
2310 in the symbol table, the @var{sec} number is the section number, the
2311 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2312 symbol's type, the @var{scl} number is the symbol's storage class and
2313 the @var{nx} value is the number of auxilary entries associated with
2314 the symbol. The last two fields are the symbol's value and its name.
2316 The other common output format, usually seen with ELF based files,
2320 00000000 l d .bss 00000000 .bss
2321 00000000 g .text 00000000 fred
2324 Here the first number is the symbol's value (sometimes refered to as
2325 its address). The next field is actually a set of characters and
2326 spaces indicating the flag bits that are set on the symbol. These
2327 characters are described below. Next is the section with which the
2328 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2329 not connected with any section), or @emph{*UND*} if the section is
2330 referenced in the file being dumped, but not defined there.
2332 After the section name comes another field, a number, which for common
2333 symbols is the alignment and for other symbol is the size. Finally
2334 the symbol's name is displayed.
2336 The flag characters are divided into 7 groups as follows:
2342 The symbol is a local (l), global (g), unique global (u), neither
2343 global nor local (a space) or both global and local (!). A
2344 symbol can be neither local or global for a variety of reasons, e.g.,
2345 because it is used for debugging, but it is probably an indication of
2346 a bug if it is ever both local and global. Unique global symbols are
2347 a GNU extension to the standard set of ELF symbol bindings. For such
2348 a symbol the dynamic linker will make sure that in the entire process
2349 there is just one symbol with this name and type in use.
2352 The symbol is weak (w) or strong (a space).
2355 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2358 The symbol is a warning (W) or a normal symbol (a space). A warning
2359 symbol's name is a message to be displayed if the symbol following the
2360 warning symbol is ever referenced.
2364 The symbol is an indirect reference to another symbol (I), a function
2365 to be evaluated during reloc processing (i) or a normal symbol (a
2370 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2371 normal symbol (a space).
2376 The symbol is the name of a function (F) or a file (f) or an object
2377 (O) or just a normal symbol (a space).
2381 @itemx --dynamic-syms
2382 @cindex dynamic symbol table entries, printing
2383 Print the dynamic symbol table entries of the file. This is only
2384 meaningful for dynamic objects, such as certain types of shared
2385 libraries. This is similar to the information provided by the @samp{nm}
2386 program when given the @option{-D} (@option{--dynamic}) option.
2388 @item --special-syms
2389 When displaying symbols include those which the target considers to be
2390 special in some way and which would not normally be of interest to the
2395 Print the version number of @command{objdump} and exit.
2398 @itemx --all-headers
2399 @cindex all header information, object file
2400 @cindex header information, all
2401 Display all available header information, including the symbol table and
2402 relocation entries. Using @option{-x} is equivalent to specifying all of
2403 @option{-a -f -h -p -r -t}.
2407 @cindex wide output, printing
2408 Format some lines for output devices that have more than 80 columns.
2409 Also do not truncate symbol names when they are displayed.
2412 @itemx --disassemble-zeroes
2413 Normally the disassembly output will skip blocks of zeroes. This
2414 option directs the disassembler to disassemble those blocks, just like
2421 @c man begin SEEALSO objdump
2422 nm(1), readelf(1), and the Info entries for @file{binutils}.
2430 @cindex archive contents
2431 @cindex symbol index
2433 @c man title ranlib generate index to archive.
2436 @c man begin SYNOPSIS ranlib
2437 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2441 @c man begin DESCRIPTION ranlib
2443 @command{ranlib} generates an index to the contents of an archive and
2444 stores it in the archive. The index lists each symbol defined by a
2445 member of an archive that is a relocatable object file.
2447 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2449 An archive with such an index speeds up linking to the library and
2450 allows routines in the library to call each other without regard to
2451 their placement in the archive.
2453 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2454 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2459 @c man begin OPTIONS ranlib
2465 Show usage information for @command{ranlib}.
2470 Show the version number of @command{ranlib}.
2473 @cindex deterministic archives
2474 @kindex --enable-deterministic-archives
2475 Operate in @emph{deterministic} mode. The symbol map archive member's
2476 header will show zero for the UID, GID, and timestamp. When this
2477 option is used, multiple runs will produce identical output files.
2479 If @file{binutils} was configured with
2480 @option{--enable-deterministic-archives}, then this mode is on by
2481 default. It can be disabled with the @samp{-U} option, described
2485 Update the timestamp of the symbol map of an archive.
2488 @cindex deterministic archives
2489 @kindex --enable-deterministic-archives
2490 Do @emph{not} operate in @emph{deterministic} mode. This is the
2491 inverse of the @samp{-D} option, above: the archive index will get
2492 actual UID, GID, timestamp, and file mode values.
2494 If @file{binutils} was configured @emph{without}
2495 @option{--enable-deterministic-archives}, then this mode is on by
2503 @c man begin SEEALSO ranlib
2504 ar(1), nm(1), and the Info entries for @file{binutils}.
2512 @cindex section sizes
2514 @c man title size list section sizes and total size.
2517 @c man begin SYNOPSIS size
2518 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2520 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2522 [@option{-t}|@option{--totals}]
2523 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2524 [@var{objfile}@dots{}]
2528 @c man begin DESCRIPTION size
2530 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2531 size---for each of the object or archive files @var{objfile} in its
2532 argument list. By default, one line of output is generated for each
2533 object file or each module in an archive.
2535 @var{objfile}@dots{} are the object files to be examined.
2536 If none are specified, the file @code{a.out} will be used.
2540 @c man begin OPTIONS size
2542 The command line options have the following meanings:
2547 @itemx --format=@var{compatibility}
2548 @cindex @command{size} display format
2549 Using one of these options, you can choose whether the output from @sc{gnu}
2550 @command{size} resembles output from System V @command{size} (using @option{-A},
2551 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2552 @option{--format=berkeley}). The default is the one-line format similar to
2554 @c Bonus for doc-source readers: you can also say --format=strange (or
2555 @c anything else that starts with 's') for sysv, and --format=boring (or
2556 @c anything else that starts with 'b') for Berkeley.
2558 Here is an example of the Berkeley (default) format of output from
2561 $ size --format=Berkeley ranlib size
2562 text data bss dec hex filename
2563 294880 81920 11592 388392 5ed28 ranlib
2564 294880 81920 11888 388688 5ee50 size
2568 This is the same data, but displayed closer to System V conventions:
2571 $ size --format=SysV ranlib size
2589 Show a summary of acceptable arguments and options.
2594 @itemx --radix=@var{number}
2595 @cindex @command{size} number format
2596 @cindex radix for section sizes
2597 Using one of these options, you can control whether the size of each
2598 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2599 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2600 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2601 values (8, 10, 16) are supported. The total size is always given in two
2602 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2603 octal and hexadecimal if you're using @option{-o}.
2606 Print total size of common symbols in each file. When using Berkeley
2607 format these are included in the bss size.
2611 Show totals of all objects listed (Berkeley format listing mode only).
2613 @item --target=@var{bfdname}
2614 @cindex object code format
2615 Specify that the object-code format for @var{objfile} is
2616 @var{bfdname}. This option may not be necessary; @command{size} can
2617 automatically recognize many formats.
2618 @xref{Target Selection}, for more information.
2622 Display the version number of @command{size}.
2628 @c man begin SEEALSO size
2629 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2636 @cindex listings strings
2637 @cindex printing strings
2638 @cindex strings, printing
2640 @c man title strings print the strings of printable characters in files.
2643 @c man begin SYNOPSIS strings
2644 strings [@option{-afovV}] [@option{-}@var{min-len}]
2645 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2646 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2647 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2648 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2649 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2650 [@option{--help}] [@option{--version}] @var{file}@dots{}
2654 @c man begin DESCRIPTION strings
2656 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2657 character sequences that are at least 4 characters long (or the number
2658 given with the options below) and are followed by an unprintable
2659 character. By default, it only prints the strings from the initialized
2660 and loaded sections of object files; for other types of files, it prints
2661 the strings from the whole file.
2663 @command{strings} is mainly useful for determining the contents of non-text
2668 @c man begin OPTIONS strings
2674 Do not scan only the initialized and loaded sections of object files;
2675 scan the whole files.
2678 @itemx --print-file-name
2679 Print the name of the file before each string.
2682 Print a summary of the program usage on the standard output and exit.
2684 @item -@var{min-len}
2685 @itemx -n @var{min-len}
2686 @itemx --bytes=@var{min-len}
2687 Print sequences of characters that are at least @var{min-len} characters
2688 long, instead of the default 4.
2691 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2692 act like @samp{-t d} instead. Since we can not be compatible with both
2693 ways, we simply chose one.
2695 @item -t @var{radix}
2696 @itemx --radix=@var{radix}
2697 Print the offset within the file before each string. The single
2698 character argument specifies the radix of the offset---@samp{o} for
2699 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2701 @item -e @var{encoding}
2702 @itemx --encoding=@var{encoding}
2703 Select the character encoding of the strings that are to be found.
2704 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2705 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2706 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2707 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2708 littleendian. Useful for finding wide character strings. (@samp{l}
2709 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2711 @item -T @var{bfdname}
2712 @itemx --target=@var{bfdname}
2713 @cindex object code format
2714 Specify an object code format other than your system's default format.
2715 @xref{Target Selection}, for more information.
2720 Print the program version number on the standard output and exit.
2726 @c man begin SEEALSO strings
2727 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2728 and the Info entries for @file{binutils}.
2736 @cindex removing symbols
2737 @cindex discarding symbols
2738 @cindex symbols, discarding
2740 @c man title strip Discard symbols from object files.
2743 @c man begin SYNOPSIS strip
2744 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2745 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2746 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2747 [@option{-s}|@option{--strip-all}]
2748 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2749 [@option{--strip-dwo}]
2750 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2751 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2752 [@option{-w}|@option{--wildcard}]
2753 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2754 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2755 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2756 [@option{-D}|@option{--enable-deterministic-archives}]
2757 [@option{-U}|@option{--disable-deterministic-archives}]
2758 [@option{--keep-file-symbols}]
2759 [@option{--only-keep-debug}]
2760 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2761 [@option{--help}] [@option{--info}]
2762 @var{objfile}@dots{}
2766 @c man begin DESCRIPTION strip
2768 @sc{gnu} @command{strip} discards all symbols from object files
2769 @var{objfile}. The list of object files may include archives.
2770 At least one object file must be given.
2772 @command{strip} modifies the files named in its argument,
2773 rather than writing modified copies under different names.
2777 @c man begin OPTIONS strip
2780 @item -F @var{bfdname}
2781 @itemx --target=@var{bfdname}
2782 Treat the original @var{objfile} as a file with the object
2783 code format @var{bfdname}, and rewrite it in the same format.
2784 @xref{Target Selection}, for more information.
2787 Show a summary of the options to @command{strip} and exit.
2790 Display a list showing all architectures and object formats available.
2792 @item -I @var{bfdname}
2793 @itemx --input-target=@var{bfdname}
2794 Treat the original @var{objfile} as a file with the object
2795 code format @var{bfdname}.
2796 @xref{Target Selection}, for more information.
2798 @item -O @var{bfdname}
2799 @itemx --output-target=@var{bfdname}
2800 Replace @var{objfile} with a file in the output format @var{bfdname}.
2801 @xref{Target Selection}, for more information.
2803 @item -R @var{sectionname}
2804 @itemx --remove-section=@var{sectionname}
2805 Remove any section named @var{sectionname} from the output file. This
2806 option may be given more than once. Note that using this option
2807 inappropriately may make the output file unusable. The wildcard
2808 character @samp{*} may be given at the end of @var{sectionname}. If
2809 so, then any section starting with @var{sectionname} will be removed.
2818 @itemx --strip-debug
2819 Remove debugging symbols only.
2822 Remove the contents of all DWARF .dwo sections, leaving the
2823 remaining debugging sections and all symbols intact.
2824 See the description of this option in the @command{objcopy} section
2825 for more information.
2827 @item --strip-unneeded
2828 Remove all symbols that are not needed for relocation processing.
2830 @item -K @var{symbolname}
2831 @itemx --keep-symbol=@var{symbolname}
2832 When stripping symbols, keep symbol @var{symbolname} even if it would
2833 normally be stripped. This option may be given more than once.
2835 @item -N @var{symbolname}
2836 @itemx --strip-symbol=@var{symbolname}
2837 Remove symbol @var{symbolname} from the source file. This option may be
2838 given more than once, and may be combined with strip options other than
2842 Put the stripped output in @var{file}, rather than replacing the
2843 existing file. When this argument is used, only one @var{objfile}
2844 argument may be specified.
2847 @itemx --preserve-dates
2848 Preserve the access and modification dates of the file.
2851 @itemx --enable-deterministic-archives
2852 @cindex deterministic archives
2853 @kindex --enable-deterministic-archives
2854 Operate in @emph{deterministic} mode. When copying archive members
2855 and writing the archive index, use zero for UIDs, GIDs, timestamps,
2856 and use consistent file modes for all files.
2858 If @file{binutils} was configured with
2859 @option{--enable-deterministic-archives}, then this mode is on by default.
2860 It can be disabled with the @samp{-U} option, below.
2863 @itemx --disable-deterministic-archives
2864 @cindex deterministic archives
2865 @kindex --enable-deterministic-archives
2866 Do @emph{not} operate in @emph{deterministic} mode. This is the
2867 inverse of the @option{-D} option, above: when copying archive members
2868 and writing the archive index, use their actual UID, GID, timestamp,
2869 and file mode values.
2871 This is the default unless @file{binutils} was configured with
2872 @option{--enable-deterministic-archives}.
2876 Permit regular expressions in @var{symbolname}s used in other command
2877 line options. The question mark (?), asterisk (*), backslash (\) and
2878 square brackets ([]) operators can be used anywhere in the symbol
2879 name. If the first character of the symbol name is the exclamation
2880 point (!) then the sense of the switch is reversed for that symbol.
2887 would cause strip to only keep symbols that start with the letters
2888 ``fo'', but to discard the symbol ``foo''.
2891 @itemx --discard-all
2892 Remove non-global symbols.
2895 @itemx --discard-locals
2896 Remove compiler-generated local symbols.
2897 (These usually start with @samp{L} or @samp{.}.)
2899 @item --keep-file-symbols
2900 When stripping a file, perhaps with @option{--strip-debug} or
2901 @option{--strip-unneeded}, retain any symbols specifying source file names,
2902 which would otherwise get stripped.
2904 @item --only-keep-debug
2905 Strip a file, removing contents of any sections that would not be
2906 stripped by @option{--strip-debug} and leaving the debugging sections
2907 intact. In ELF files, this preserves all note sections in the output.
2909 The intention is that this option will be used in conjunction with
2910 @option{--add-gnu-debuglink} to create a two part executable. One a
2911 stripped binary which will occupy less space in RAM and in a
2912 distribution and the second a debugging information file which is only
2913 needed if debugging abilities are required. The suggested procedure
2914 to create these files is as follows:
2917 @item Link the executable as normal. Assuming that is is called
2919 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2920 create a file containing the debugging info.
2921 @item Run @code{objcopy --strip-debug foo} to create a
2922 stripped executable.
2923 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2924 to add a link to the debugging info into the stripped executable.
2927 Note---the choice of @code{.dbg} as an extension for the debug info
2928 file is arbitrary. Also the @code{--only-keep-debug} step is
2929 optional. You could instead do this:
2932 @item Link the executable as normal.
2933 @item Copy @code{foo} to @code{foo.full}
2934 @item Run @code{strip --strip-debug foo}
2935 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2938 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2939 full executable. It does not have to be a file created by the
2940 @option{--only-keep-debug} switch.
2942 Note---this switch is only intended for use on fully linked files. It
2943 does not make sense to use it on object files where the debugging
2944 information may be incomplete. Besides the gnu_debuglink feature
2945 currently only supports the presence of one filename containing
2946 debugging information, not multiple filenames on a one-per-object-file
2951 Show the version number for @command{strip}.
2955 Verbose output: list all object files modified. In the case of
2956 archives, @samp{strip -v} lists all members of the archive.
2962 @c man begin SEEALSO strip
2963 the Info entries for @file{binutils}.
2967 @node c++filt, addr2line, strip, Top
2971 @cindex demangling C++ symbols
2973 @c man title cxxfilt Demangle C++ and Java symbols.
2976 @c man begin SYNOPSIS cxxfilt
2977 c++filt [@option{-_}|@option{--strip-underscore}]
2978 [@option{-n}|@option{--no-strip-underscore}]
2979 [@option{-p}|@option{--no-params}]
2980 [@option{-t}|@option{--types}]
2981 [@option{-i}|@option{--no-verbose}]
2982 [@option{-s} @var{format}|@option{--format=}@var{format}]
2983 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2987 @c man begin DESCRIPTION cxxfilt
2990 The C++ and Java languages provide function overloading, which means
2991 that you can write many functions with the same name, providing that
2992 each function takes parameters of different types. In order to be
2993 able to distinguish these similarly named functions C++ and Java
2994 encode them into a low-level assembler name which uniquely identifies
2995 each different version. This process is known as @dfn{mangling}. The
2997 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2998 MS-DOS this program is named @command{CXXFILT}.}
2999 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3000 names into user-level names so that they can be read.
3002 Every alphanumeric word (consisting of letters, digits, underscores,
3003 dollars, or periods) seen in the input is a potential mangled name.
3004 If the name decodes into a C++ name, the C++ name replaces the
3005 low-level name in the output, otherwise the original word is output.
3006 In this way you can pass an entire assembler source file, containing
3007 mangled names, through @command{c++filt} and see the same source file
3008 containing demangled names.
3010 You can also use @command{c++filt} to decipher individual symbols by
3011 passing them on the command line:
3014 c++filt @var{symbol}
3017 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3018 names from the standard input instead. All the results are printed on
3019 the standard output. The difference between reading names from the
3020 command line versus reading names from the standard input is that
3021 command line arguments are expected to be just mangled names and no
3022 checking is performed to separate them from surrounding text. Thus
3029 will work and demangle the name to ``f()'' whereas:
3035 will not work. (Note the extra comma at the end of the mangled
3036 name which makes it invalid). This command however will work:
3039 echo _Z1fv, | c++filt -n
3042 and will display ``f(),'', i.e., the demangled name followed by a
3043 trailing comma. This behaviour is because when the names are read
3044 from the standard input it is expected that they might be part of an
3045 assembler source file where there might be extra, extraneous
3046 characters trailing after a mangled name. For example:
3049 .type _Z1fv, @@function
3054 @c man begin OPTIONS cxxfilt
3058 @itemx --strip-underscore
3059 On some systems, both the C and C++ compilers put an underscore in front
3060 of every name. For example, the C name @code{foo} gets the low-level
3061 name @code{_foo}. This option removes the initial underscore. Whether
3062 @command{c++filt} removes the underscore by default is target dependent.
3065 @itemx --no-strip-underscore
3066 Do not remove the initial underscore.
3070 When demangling the name of a function, do not display the types of
3071 the function's parameters.
3075 Attempt to demangle types as well as function names. This is disabled
3076 by default since mangled types are normally only used internally in
3077 the compiler, and they can be confused with non-mangled names. For example,
3078 a function called ``a'' treated as a mangled type name would be
3079 demangled to ``signed char''.
3083 Do not include implementation details (if any) in the demangled
3086 @item -s @var{format}
3087 @itemx --format=@var{format}
3088 @command{c++filt} can decode various methods of mangling, used by
3089 different compilers. The argument to this option selects which
3094 Automatic selection based on executable (the default method)
3096 the one used by the @sc{gnu} C++ compiler (g++)
3098 the one used by the Lucid compiler (lcc)
3100 the one specified by the C++ Annotated Reference Manual
3102 the one used by the HP compiler (aCC)
3104 the one used by the EDG compiler
3106 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3108 the one used by the @sc{gnu} Java compiler (gcj)
3110 the one used by the @sc{gnu} Ada compiler (GNAT).
3114 Print a summary of the options to @command{c++filt} and exit.
3117 Print the version number of @command{c++filt} and exit.
3123 @c man begin SEEALSO cxxfilt
3124 the Info entries for @file{binutils}.
3129 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3130 user interface are subject to change in future releases. In particular,
3131 a command-line option may be required in the future to decode a name
3132 passed as an argument on the command line; in other words,
3135 c++filt @var{symbol}
3139 may in a future release become
3142 c++filt @var{option} @var{symbol}
3150 @cindex address to file name and line number
3152 @c man title addr2line convert addresses into file names and line numbers.
3155 @c man begin SYNOPSIS addr2line
3156 addr2line [@option{-a}|@option{--addresses}]
3157 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3158 [@option{-C}|@option{--demangle}[=@var{style}]]
3159 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3160 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3161 [@option{-i}|@option{--inlines}]
3162 [@option{-p}|@option{--pretty-print}]
3163 [@option{-j}|@option{--section=}@var{name}]
3164 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3169 @c man begin DESCRIPTION addr2line
3171 @command{addr2line} translates addresses into file names and line numbers.
3172 Given an address in an executable or an offset in a section of a relocatable
3173 object, it uses the debugging information to figure out which file name and
3174 line number are associated with it.
3176 The executable or relocatable object to use is specified with the @option{-e}
3177 option. The default is the file @file{a.out}. The section in the relocatable
3178 object to use is specified with the @option{-j} option.
3180 @command{addr2line} has two modes of operation.
3182 In the first, hexadecimal addresses are specified on the command line,
3183 and @command{addr2line} displays the file name and line number for each
3186 In the second, @command{addr2line} reads hexadecimal addresses from
3187 standard input, and prints the file name and line number for each
3188 address on standard output. In this mode, @command{addr2line} may be used
3189 in a pipe to convert dynamically chosen addresses.
3191 The format of the output is @samp{FILENAME:LINENO}. The file name and
3192 line number for each input address is printed on separate lines.
3194 If the @option{-f} option is used, then each @samp{FILENAME:LINENO}
3195 line is preceded by @samp{FUNCTIONNAME} which is the name of the
3196 function containing the address.
3198 If the @option{-i} option is used and the code at the given address is
3199 present there because of inlining by the compiler then the
3200 @samp{@{FUNCTIONNAME@} FILENAME:LINENO} information for the inlining
3201 function will be displayed afterwards. This continues recursively
3202 until there is no more inlining to report.
3204 If the @option{-a} option is used then the output is prefixed by the
3207 If the @option{-p} option is used then the output for each input
3208 address is displayed on one, possibly quite long, line. If
3209 @option{-p} is not used then the output is broken up into multiple
3210 lines, based on the paragraphs above.
3212 If the file name or function name can not be determined,
3213 @command{addr2line} will print two question marks in their place. If the
3214 line number can not be determined, @command{addr2line} will print 0.
3218 @c man begin OPTIONS addr2line
3220 The long and short forms of options, shown here as alternatives, are
3226 Display the address before the function name, file and line number
3227 information. The address is printed with a @samp{0x} prefix to easily
3230 @item -b @var{bfdname}
3231 @itemx --target=@var{bfdname}
3232 @cindex object code format
3233 Specify that the object-code format for the object files is
3237 @itemx --demangle[=@var{style}]
3238 @cindex demangling in objdump
3239 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3240 Besides removing any initial underscore prepended by the system, this
3241 makes C++ function names readable. Different compilers have different
3242 mangling styles. The optional demangling style argument can be used to
3243 choose an appropriate demangling style for your compiler. @xref{c++filt},
3244 for more information on demangling.
3246 @item -e @var{filename}
3247 @itemx --exe=@var{filename}
3248 Specify the name of the executable for which addresses should be
3249 translated. The default file is @file{a.out}.
3253 Display function names as well as file and line number information.
3257 Display only the base of each file name.
3261 If the address belongs to a function that was inlined, the source
3262 information for all enclosing scopes back to the first non-inlined
3263 function will also be printed. For example, if @code{main} inlines
3264 @code{callee1} which inlines @code{callee2}, and address is from
3265 @code{callee2}, the source information for @code{callee1} and @code{main}
3266 will also be printed.
3270 Read offsets relative to the specified section instead of absolute addresses.
3273 @itemx --pretty-print
3274 Make the output more human friendly: each location are printed on one line.
3275 If option @option{-i} is specified, lines for all enclosing scopes are
3276 prefixed with @samp{(inlined by)}.
3282 @c man begin SEEALSO addr2line
3283 Info entries for @file{binutils}.
3290 @command{nlmconv} converts a relocatable object file into a NetWare
3294 @command{nlmconv} currently works with @samp{i386} object
3295 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3296 object files in @sc{elf}, or @code{a.out} format@footnote{
3297 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3298 format in the Binary File Descriptor library. It has only been tested
3299 with the above formats.}.
3303 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3304 utilities, since it is only useful for NLM targets.
3307 @c man title nlmconv converts object code into an NLM.
3310 @c man begin SYNOPSIS nlmconv
3311 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3312 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3313 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3314 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3315 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3316 @var{infile} @var{outfile}
3320 @c man begin DESCRIPTION nlmconv
3322 @command{nlmconv} converts the relocatable @samp{i386} object file
3323 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3324 reading @var{headerfile} for NLM header information. For instructions
3325 on writing the NLM command file language used in header files, see the
3326 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3327 Development and Tools Overview}, which is part of the NLM Software
3328 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3329 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3332 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3335 @command{nlmconv} can perform a link step. In other words, you can list
3336 more than one object file for input if you list them in the definitions
3337 file (rather than simply specifying one input file on the command line).
3338 In this case, @command{nlmconv} calls the linker for you.
3342 @c man begin OPTIONS nlmconv
3345 @item -I @var{bfdname}
3346 @itemx --input-target=@var{bfdname}
3347 Object format of the input file. @command{nlmconv} can usually determine
3348 the format of a given file (so no default is necessary).
3349 @xref{Target Selection}, for more information.
3351 @item -O @var{bfdname}
3352 @itemx --output-target=@var{bfdname}
3353 Object format of the output file. @command{nlmconv} infers the output
3354 format based on the input format, e.g. for a @samp{i386} input file the
3355 output format is @samp{nlm32-i386}.
3356 @xref{Target Selection}, for more information.
3358 @item -T @var{headerfile}
3359 @itemx --header-file=@var{headerfile}
3360 Reads @var{headerfile} for NLM header information. For instructions on
3361 writing the NLM command file language used in header files, see@ see the
3362 @samp{linkers} section, of the @cite{NLM Development and Tools
3363 Overview}, which is part of the NLM Software Developer's Kit, available
3368 Displays (on standard error) the linker command line used by @command{nlmconv}.
3370 @item -l @var{linker}
3371 @itemx --linker=@var{linker}
3372 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3377 Prints a usage summary.
3381 Prints the version number for @command{nlmconv}.
3387 @c man begin SEEALSO nlmconv
3388 the Info entries for @file{binutils}.
3395 @command{windmc} may be used to generator Windows message resources.
3398 @emph{Warning:} @command{windmc} is not always built as part of the binary
3399 utilities, since it is only useful for Windows targets.
3402 @c man title windmc generates Windows message resources.
3405 @c man begin SYNOPSIS windmc
3406 windmc [options] input-file
3410 @c man begin DESCRIPTION windmc
3412 @command{windmc} reads message definitions from an input file (.mc) and
3413 translate them into a set of output files. The output files may be of
3418 A C header file containing the message definitions.
3421 A resource file compilable by the @command{windres} tool.
3424 One or more binary files containing the resource data for a specific
3428 A C include file that maps message id's to their symbolic name.
3431 The exact description of these different formats is available in
3432 documentation from Microsoft.
3434 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3435 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3436 Windows Message Compiler.
3440 @c man begin OPTIONS windmc
3445 Specifies that the input file specified is ASCII. This is the default
3450 Specifies that messages in the output @code{bin} files should be in ASCII
3455 Specifies that @code{bin} filenames should have to be prefixed by the
3456 basename of the source file.
3460 Sets the customer bit in all message id's.
3462 @item -C @var{codepage}
3463 @itemx --codepage_in @var{codepage}
3464 Sets the default codepage to be used to convert input file to UTF16. The
3465 default is ocdepage 1252.
3468 @itemx --decimal_values
3469 Outputs the constants in the header file in decimal. Default is using
3473 @itemx --extension @var{ext}
3474 The extension for the header file. The default is .h extension.
3476 @item -F @var{target}
3477 @itemx --target @var{target}
3478 Specify the BFD format to use for a bin file as output. This
3479 is a BFD target name; you can use the @option{--help} option to see a list
3480 of supported targets. Normally @command{windmc} will use the default
3481 format, which is the first one listed by the @option{--help} option.
3483 @ref{Target Selection}.
3487 @itemx --headerdir @var{path}
3488 The target directory of the generated header file. The default is the
3493 Displays a list of command line options and then exits.
3495 @item -m @var{characters}
3496 @itemx --maxlength @var{characters}
3497 Instructs @command{windmc} to generate a warning if the length
3498 of any message exceeds the number specified.
3501 @itemx --nullterminate
3502 Terminate message text in @code{bin} files by zero. By default they are
3503 terminated by CR/LF.
3506 @itemx --hresult_use
3507 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3508 file, using HRESULT definitions. Status codes are used if the flag is not
3511 @item -O @var{codepage}
3512 @itemx --codepage_out @var{codepage}
3513 Sets the default codepage to be used to output text files. The default
3517 @itemx --rcdir @var{path}
3518 The target directory for the generated @code{rc} script and the generated
3519 @code{bin} files that the resource compiler script includes. The default
3520 is the current directory.
3524 Specifies that the input file is UTF16.
3527 @itemx --unicode_out
3528 Specifies that messages in the output @code{bin} file should be in UTF16
3529 format. This is the default behaviour.
3533 Enable verbose mode.
3537 Prints the version number for @command{windmc}.
3540 @itemx --xdgb @var{path}
3541 The path of the @code{dbg} C include file that maps message id's to the
3542 symbolic name. No such file is generated without specifying the switch.
3548 @c man begin SEEALSO windmc
3549 the Info entries for @file{binutils}.
3556 @command{windres} may be used to manipulate Windows resources.
3559 @emph{Warning:} @command{windres} is not always built as part of the binary
3560 utilities, since it is only useful for Windows targets.
3563 @c man title windres manipulate Windows resources.
3566 @c man begin SYNOPSIS windres
3567 windres [options] [input-file] [output-file]
3571 @c man begin DESCRIPTION windres
3573 @command{windres} reads resources from an input file and copies them into
3574 an output file. Either file may be in one of three formats:
3578 A text format read by the Resource Compiler.
3581 A binary format generated by the Resource Compiler.
3584 A COFF object or executable.
3587 The exact description of these different formats is available in
3588 documentation from Microsoft.
3590 When @command{windres} converts from the @code{rc} format to the @code{res}
3591 format, it is acting like the Windows Resource Compiler. When
3592 @command{windres} converts from the @code{res} format to the @code{coff}
3593 format, it is acting like the Windows @code{CVTRES} program.
3595 When @command{windres} generates an @code{rc} file, the output is similar
3596 but not identical to the format expected for the input. When an input
3597 @code{rc} file refers to an external filename, an output @code{rc} file
3598 will instead include the file contents.
3600 If the input or output format is not specified, @command{windres} will
3601 guess based on the file name, or, for the input file, the file contents.
3602 A file with an extension of @file{.rc} will be treated as an @code{rc}
3603 file, a file with an extension of @file{.res} will be treated as a
3604 @code{res} file, and a file with an extension of @file{.o} or
3605 @file{.exe} will be treated as a @code{coff} file.
3607 If no output file is specified, @command{windres} will print the resources
3608 in @code{rc} format to standard output.
3610 The normal use is for you to write an @code{rc} file, use @command{windres}
3611 to convert it to a COFF object file, and then link the COFF file into
3612 your application. This will make the resources described in the
3613 @code{rc} file available to Windows.
3617 @c man begin OPTIONS windres
3620 @item -i @var{filename}
3621 @itemx --input @var{filename}
3622 The name of the input file. If this option is not used, then
3623 @command{windres} will use the first non-option argument as the input file
3624 name. If there are no non-option arguments, then @command{windres} will
3625 read from standard input. @command{windres} can not read a COFF file from
3628 @item -o @var{filename}
3629 @itemx --output @var{filename}
3630 The name of the output file. If this option is not used, then
3631 @command{windres} will use the first non-option argument, after any used
3632 for the input file name, as the output file name. If there is no
3633 non-option argument, then @command{windres} will write to standard output.
3634 @command{windres} can not write a COFF file to standard output. Note,
3635 for compatibility with @command{rc} the option @option{-fo} is also
3636 accepted, but its use is not recommended.
3638 @item -J @var{format}
3639 @itemx --input-format @var{format}
3640 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3641 @samp{coff}. If no input format is specified, @command{windres} will
3642 guess, as described above.
3644 @item -O @var{format}
3645 @itemx --output-format @var{format}
3646 The output format to generate. @var{format} may be @samp{res},
3647 @samp{rc}, or @samp{coff}. If no output format is specified,
3648 @command{windres} will guess, as described above.
3650 @item -F @var{target}
3651 @itemx --target @var{target}
3652 Specify the BFD format to use for a COFF file as input or output. This
3653 is a BFD target name; you can use the @option{--help} option to see a list
3654 of supported targets. Normally @command{windres} will use the default
3655 format, which is the first one listed by the @option{--help} option.
3657 @ref{Target Selection}.
3660 @item --preprocessor @var{program}
3661 When @command{windres} reads an @code{rc} file, it runs it through the C
3662 preprocessor first. This option may be used to specify the preprocessor
3663 to use, including any leading arguments. The default preprocessor
3664 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3666 @item --preprocessor-arg @var{option}
3667 When @command{windres} reads an @code{rc} file, it runs it through
3668 the C preprocessor first. This option may be used to specify additional
3669 text to be passed to preprocessor on its command line.
3670 This option can be used multiple times to add multiple options to the
3671 preprocessor command line.
3673 @item -I @var{directory}
3674 @itemx --include-dir @var{directory}
3675 Specify an include directory to use when reading an @code{rc} file.
3676 @command{windres} will pass this to the preprocessor as an @option{-I}
3677 option. @command{windres} will also search this directory when looking for
3678 files named in the @code{rc} file. If the argument passed to this command
3679 matches any of the supported @var{formats} (as described in the @option{-J}
3680 option), it will issue a deprecation warning, and behave just like the
3681 @option{-J} option. New programs should not use this behaviour. If a
3682 directory happens to match a @var{format}, simple prefix it with @samp{./}
3683 to disable the backward compatibility.
3685 @item -D @var{target}
3686 @itemx --define @var{sym}[=@var{val}]
3687 Specify a @option{-D} option to pass to the preprocessor when reading an
3690 @item -U @var{target}
3691 @itemx --undefine @var{sym}
3692 Specify a @option{-U} option to pass to the preprocessor when reading an
3696 Ignored for compatibility with rc.
3699 Enable verbose mode. This tells you what the preprocessor is if you
3703 @item --codepage @var{val}
3704 Specify the default codepage to use when reading an @code{rc} file.
3705 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3706 codepage code. The valid range is from zero up to 0xffff, but the
3707 validity of the codepage is host and configuration dependent.
3710 @item --language @var{val}
3711 Specify the default language to use when reading an @code{rc} file.
3712 @var{val} should be a hexadecimal language code. The low eight bits are
3713 the language, and the high eight bits are the sublanguage.
3715 @item --use-temp-file
3716 Use a temporary file to instead of using popen to read the output of
3717 the preprocessor. Use this option if the popen implementation is buggy
3718 on the host (eg., certain non-English language versions of Windows 95 and
3719 Windows 98 are known to have buggy popen where the output will instead
3722 @item --no-use-temp-file
3723 Use popen, not a temporary file, to read the output of the preprocessor.
3724 This is the default behaviour.
3728 Prints a usage summary.
3732 Prints the version number for @command{windres}.
3735 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3736 this will turn on parser debugging.
3742 @c man begin SEEALSO windres
3743 the Info entries for @file{binutils}.
3752 @command{dlltool} is used to create the files needed to create dynamic
3753 link libraries (DLLs) on systems which understand PE format image
3754 files such as Windows. A DLL contains an export table which contains
3755 information that the runtime loader needs to resolve references from a
3756 referencing program.
3758 The export table is generated by this program by reading in a
3759 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3760 will be in the DLL. A @file{.o} file can contain information in
3761 special @samp{.drectve} sections with export information.
3764 @emph{Note:} @command{dlltool} is not always built as part of the
3765 binary utilities, since it is only useful for those targets which
3769 @c man title dlltool Create files needed to build and use DLLs.
3772 @c man begin SYNOPSIS dlltool
3773 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3774 [@option{-b}|@option{--base-file} @var{base-file-name}]
3775 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3776 [@option{-z}|@option{--output-def} @var{def-file-name}]
3777 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3778 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3779 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3780 [@option{--exclude-symbols} @var{list}]
3781 [@option{--no-default-excludes}]
3782 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3783 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3784 [@option{-a}|@option{--add-indirect}]
3785 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3786 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3787 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3788 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3789 [@option{--use-nul-prefixed-import-tables}]
3790 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3791 [@option{-i}|@option{--interwork}]
3792 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3793 [@option{-v}|@option{--verbose}]
3794 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3795 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
3796 [object-file @dots{}]
3800 @c man begin DESCRIPTION dlltool
3802 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3803 @option{-b} options as well as object files specified on the command
3804 line. It then processes these inputs and if the @option{-e} option has
3805 been specified it creates a exports file. If the @option{-l} option
3806 has been specified it creates a library file and if the @option{-z} option
3807 has been specified it creates a def file. Any or all of the @option{-e},
3808 @option{-l} and @option{-z} options can be present in one invocation of
3811 When creating a DLL, along with the source for the DLL, it is necessary
3812 to have three other files. @command{dlltool} can help with the creation of
3815 The first file is a @file{.def} file which specifies which functions are
3816 exported from the DLL, which functions the DLL imports, and so on. This
3817 is a text file and can be created by hand, or @command{dlltool} can be used
3818 to create it using the @option{-z} option. In this case @command{dlltool}
3819 will scan the object files specified on its command line looking for
3820 those functions which have been specially marked as being exported and
3821 put entries for them in the @file{.def} file it creates.
3823 In order to mark a function as being exported from a DLL, it needs to
3824 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3825 section of the object file. This can be done in C by using the
3829 asm (".section .drectve");
3830 asm (".ascii \"-export:my_func\"");
3832 int my_func (void) @{ @dots{} @}
3835 The second file needed for DLL creation is an exports file. This file
3836 is linked with the object files that make up the body of the DLL and it
3837 handles the interface between the DLL and the outside world. This is a
3838 binary file and it can be created by giving the @option{-e} option to
3839 @command{dlltool} when it is creating or reading in a @file{.def} file.
3841 The third file needed for DLL creation is the library file that programs
3842 will link with in order to access the functions in the DLL (an `import
3843 library'). This file can be created by giving the @option{-l} option to
3844 dlltool when it is creating or reading in a @file{.def} file.
3846 If the @option{-y} option is specified, dlltool generates a delay-import
3847 library that can be used instead of the normal import library to allow
3848 a program to link to the dll only as soon as an imported function is
3849 called for the first time. The resulting executable will need to be
3850 linked to the static delayimp library containing __delayLoadHelper2(),
3851 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
3853 @command{dlltool} builds the library file by hand, but it builds the
3854 exports file by creating temporary files containing assembler statements
3855 and then assembling these. The @option{-S} command line option can be
3856 used to specify the path to the assembler that dlltool will use,
3857 and the @option{-f} option can be used to pass specific flags to that
3858 assembler. The @option{-n} can be used to prevent dlltool from deleting
3859 these temporary assembler files when it is done, and if @option{-n} is
3860 specified twice then this will prevent dlltool from deleting the
3861 temporary object files it used to build the library.
3863 Here is an example of creating a DLL from a source file @samp{dll.c} and
3864 also creating a program (from an object file called @samp{program.o})
3869 dlltool -e exports.o -l dll.lib dll.o
3870 gcc dll.o exports.o -o dll.dll
3871 gcc program.o dll.lib -o program
3875 @command{dlltool} may also be used to query an existing import library
3876 to determine the name of the DLL to which it is associated. See the
3877 description of the @option{-I} or @option{--identify} option.
3881 @c man begin OPTIONS dlltool
3883 The command line options have the following meanings:
3887 @item -d @var{filename}
3888 @itemx --input-def @var{filename}
3889 @cindex input .def file
3890 Specifies the name of a @file{.def} file to be read in and processed.
3892 @item -b @var{filename}
3893 @itemx --base-file @var{filename}
3895 Specifies the name of a base file to be read in and processed. The
3896 contents of this file will be added to the relocation section in the
3897 exports file generated by dlltool.
3899 @item -e @var{filename}
3900 @itemx --output-exp @var{filename}
3901 Specifies the name of the export file to be created by dlltool.
3903 @item -z @var{filename}
3904 @itemx --output-def @var{filename}
3905 Specifies the name of the @file{.def} file to be created by dlltool.
3907 @item -l @var{filename}
3908 @itemx --output-lib @var{filename}
3909 Specifies the name of the library file to be created by dlltool.
3911 @item -y @var{filename}
3912 @itemx --output-delaylib @var{filename}
3913 Specifies the name of the delay-import library file to be created by dlltool.
3915 @item --export-all-symbols
3916 Treat all global and weak defined symbols found in the input object
3917 files as symbols to be exported. There is a small list of symbols which
3918 are not exported by default; see the @option{--no-default-excludes}
3919 option. You may add to the list of symbols to not export by using the
3920 @option{--exclude-symbols} option.
3922 @item --no-export-all-symbols
3923 Only export symbols explicitly listed in an input @file{.def} file or in
3924 @samp{.drectve} sections in the input object files. This is the default
3925 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3926 attributes in the source code.
3928 @item --exclude-symbols @var{list}
3929 Do not export the symbols in @var{list}. This is a list of symbol names
3930 separated by comma or colon characters. The symbol names should not
3931 contain a leading underscore. This is only meaningful when
3932 @option{--export-all-symbols} is used.
3934 @item --no-default-excludes
3935 When @option{--export-all-symbols} is used, it will by default avoid
3936 exporting certain special symbols. The current list of symbols to avoid
3937 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3938 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3939 to go ahead and export these special symbols. This is only meaningful
3940 when @option{--export-all-symbols} is used.
3943 @itemx --as @var{path}
3944 Specifies the path, including the filename, of the assembler to be used
3945 to create the exports file.
3947 @item -f @var{options}
3948 @itemx --as-flags @var{options}
3949 Specifies any specific command line options to be passed to the
3950 assembler when building the exports file. This option will work even if
3951 the @option{-S} option is not used. This option only takes one argument,
3952 and if it occurs more than once on the command line, then later
3953 occurrences will override earlier occurrences. So if it is necessary to
3954 pass multiple options to the assembler they should be enclosed in
3958 @itemx --dll-name @var{name}
3959 Specifies the name to be stored in the @file{.def} file as the name of
3960 the DLL when the @option{-e} option is used. If this option is not
3961 present, then the filename given to the @option{-e} option will be
3962 used as the name of the DLL.
3964 @item -m @var{machine}
3965 @itemx -machine @var{machine}
3966 Specifies the type of machine for which the library file should be
3967 built. @command{dlltool} has a built in default type, depending upon how
3968 it was created, but this option can be used to override that. This is
3969 normally only useful when creating DLLs for an ARM processor, when the
3970 contents of the DLL are actually encode using Thumb instructions.
3973 @itemx --add-indirect
3974 Specifies that when @command{dlltool} is creating the exports file it
3975 should add a section which allows the exported functions to be
3976 referenced without using the import library. Whatever the hell that
3980 @itemx --add-underscore
3981 Specifies that when @command{dlltool} is creating the exports file it
3982 should prepend an underscore to the names of @emph{all} exported symbols.
3984 @item --no-leading-underscore
3985 @item --leading-underscore
3986 Specifies whether standard symbol should be forced to be prefixed, or
3989 @item --add-stdcall-underscore
3990 Specifies that when @command{dlltool} is creating the exports file it
3991 should prepend an underscore to the names of exported @emph{stdcall}
3992 functions. Variable names and non-stdcall function names are not modified.
3993 This option is useful when creating GNU-compatible import libs for third
3994 party DLLs that were built with MS-Windows tools.
3998 Specifies that when @command{dlltool} is creating the exports file it
3999 should not append the string @samp{@@ <number>}. These numbers are
4000 called ordinal numbers and they represent another way of accessing the
4001 function in a DLL, other than by name.
4004 @itemx --add-stdcall-alias
4005 Specifies that when @command{dlltool} is creating the exports file it
4006 should add aliases for stdcall symbols without @samp{@@ <number>}
4007 in addition to the symbols with @samp{@@ <number>}.
4010 @itemx --ext-prefix-alias @var{prefix}
4011 Causes @command{dlltool} to create external aliases for all DLL
4012 imports with the specified prefix. The aliases are created for both
4013 external and import symbols with no leading underscore.
4017 Specifies that when @command{dlltool} is creating the exports and library
4018 files it should omit the @code{.idata4} section. This is for compatibility
4019 with certain operating systems.
4021 @item --use-nul-prefixed-import-tables
4022 Specifies that when @command{dlltool} is creating the exports and library
4023 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4024 element. This emulates old gnu import library generation of
4025 @code{dlltool}. By default this option is turned off.
4029 Specifies that when @command{dlltool} is creating the exports and library
4030 files it should omit the @code{.idata5} section. This is for compatibility
4031 with certain operating systems.
4033 @item -I @var{filename}
4034 @itemx --identify @var{filename}
4035 Specifies that @command{dlltool} should inspect the import library
4036 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4037 of the associated DLL(s). This can be performed in addition to any
4038 other operations indicated by the other options and arguments.
4039 @command{dlltool} fails if the import library does not exist or is not
4040 actually an import library. See also @option{--identify-strict}.
4042 @item --identify-strict
4043 Modifies the behavior of the @option{--identify} option, such
4044 that an error is reported if @var{filename} is associated with
4049 Specifies that @command{dlltool} should mark the objects in the library
4050 file and exports file that it produces as supporting interworking
4051 between ARM and Thumb code.
4055 Makes @command{dlltool} preserve the temporary assembler files it used to
4056 create the exports file. If this option is repeated then dlltool will
4057 also preserve the temporary object files it uses to create the library
4060 @item -t @var{prefix}
4061 @itemx --temp-prefix @var{prefix}
4062 Makes @command{dlltool} use @var{prefix} when constructing the names of
4063 temporary assembler and object files. By default, the temp file prefix
4064 is generated from the pid.
4068 Make dlltool describe what it is doing.
4072 Displays a list of command line options and then exits.
4076 Displays dlltool's version number and then exits.
4083 * def file format:: The format of the dlltool @file{.def} file
4086 @node def file format
4087 @section The format of the @command{dlltool} @file{.def} file
4089 A @file{.def} file contains any number of the following commands:
4093 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4094 The result is going to be named @var{name}@code{.exe}.
4096 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4097 The result is going to be named @var{name}@code{.dll}.
4098 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4099 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4102 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4103 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4104 Declares @var{name1} as an exported symbol from the DLL, with optional
4105 ordinal number @var{integer}, or declares @var{name1} as an alias
4106 (forward) of the function @var{external-name} in the DLL.
4107 If @var{its_name} is specified, this name is used as string in export table.
4109 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4110 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4111 If you want to use LIBRARY as name then you need to quote it.
4113 @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{]} *}
4114 Declares that @var{external-name} or the exported function whose
4115 ordinal number is @var{integer} is to be imported from the file
4116 @var{module-name}. If @var{internal-name} is specified then this is
4117 the name that the imported function will be referred to in the body of
4119 If @var{its_name} is specified, this name is used as string in import table.
4120 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4121 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4122 If you want to use LIBRARY as name then you need to quote it.
4124 @item @code{DESCRIPTION} @var{string}
4125 Puts @var{string} into the output @file{.exp} file in the
4126 @code{.rdata} section.
4128 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4129 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4130 Generates @code{--stack} or @code{--heap}
4131 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4132 section. The linker will see this and act upon it.
4134 @item @code{CODE} @var{attr} @code{+}
4135 @item @code{DATA} @var{attr} @code{+}
4136 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4137 Generates @code{--attr} @var{section-name} @var{attr} in the output
4138 @code{.drectve} section, where @var{attr} is one of @code{READ},
4139 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4140 this and act upon it.
4145 @c man begin SEEALSO dlltool
4146 The Info pages for @file{binutils}.
4153 @cindex ELF file information
4156 @c man title readelf Displays information about ELF files.
4159 @c man begin SYNOPSIS readelf
4160 readelf [@option{-a}|@option{--all}]
4161 [@option{-h}|@option{--file-header}]
4162 [@option{-l}|@option{--program-headers}|@option{--segments}]
4163 [@option{-S}|@option{--section-headers}|@option{--sections}]
4164 [@option{-g}|@option{--section-groups}]
4165 [@option{-t}|@option{--section-details}]
4166 [@option{-e}|@option{--headers}]
4167 [@option{-s}|@option{--syms}|@option{--symbols}]
4168 [@option{--dyn-syms}]
4169 [@option{-n}|@option{--notes}]
4170 [@option{-r}|@option{--relocs}]
4171 [@option{-u}|@option{--unwind}]
4172 [@option{-d}|@option{--dynamic}]
4173 [@option{-V}|@option{--version-info}]
4174 [@option{-A}|@option{--arch-specific}]
4175 [@option{-D}|@option{--use-dynamic}]
4176 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4177 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4178 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4179 [@option{-c}|@option{--archive-index}]
4180 [@option{-w[lLiaprmfFsoRt]}|
4181 @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]]
4182 [@option{--dwarf-depth=@var{n}}]
4183 [@option{--dwarf-start=@var{n}}]
4184 [@option{-I}|@option{--histogram}]
4185 [@option{-v}|@option{--version}]
4186 [@option{-W}|@option{--wide}]
4187 [@option{-H}|@option{--help}]
4188 @var{elffile}@dots{}
4192 @c man begin DESCRIPTION readelf
4194 @command{readelf} displays information about one or more ELF format object
4195 files. The options control what particular information to display.
4197 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4198 64-bit ELF files are supported, as are archives containing ELF files.
4200 This program performs a similar function to @command{objdump} but it
4201 goes into more detail and it exists independently of the @sc{bfd}
4202 library, so if there is a bug in @sc{bfd} then readelf will not be
4207 @c man begin OPTIONS readelf
4209 The long and short forms of options, shown here as alternatives, are
4210 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4216 Equivalent to specifying @option{--file-header},
4217 @option{--program-headers}, @option{--sections}, @option{--symbols},
4218 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4219 @option{--version-info}.
4222 @itemx --file-header
4223 @cindex ELF file header information
4224 Displays the information contained in the ELF header at the start of the
4228 @itemx --program-headers
4230 @cindex ELF program header information
4231 @cindex ELF segment information
4232 Displays the information contained in the file's segment headers, if it
4237 @itemx --section-headers
4238 @cindex ELF section information
4239 Displays the information contained in the file's section headers, if it
4243 @itemx --section-groups
4244 @cindex ELF section group information
4245 Displays the information contained in the file's section groups, if it
4249 @itemx --section-details
4250 @cindex ELF section information
4251 Displays the detailed section information. Implies @option{-S}.
4256 @cindex ELF symbol table information
4257 Displays the entries in symbol table section of the file, if it has one.
4260 @cindex ELF dynamic symbol table information
4261 Displays the entries in dynamic symbol table section of the file, if it
4266 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4271 Displays the contents of the NOTE segments and/or sections, if any.
4275 @cindex ELF reloc information
4276 Displays the contents of the file's relocation section, if it has one.
4280 @cindex unwind information
4281 Displays the contents of the file's unwind section, if it has one. Only
4282 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4283 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4287 @cindex ELF dynamic section information
4288 Displays the contents of the file's dynamic section, if it has one.
4291 @itemx --version-info
4292 @cindex ELF version sections information
4293 Displays the contents of the version sections in the file, it they
4297 @itemx --arch-specific
4298 Displays architecture-specific information in the file, if there
4302 @itemx --use-dynamic
4303 When displaying symbols, this option makes @command{readelf} use the
4304 symbol hash tables in the file's dynamic section, rather than the
4305 symbol table sections.
4307 @item -x <number or name>
4308 @itemx --hex-dump=<number or name>
4309 Displays the contents of the indicated section as a hexadecimal bytes.
4310 A number identifies a particular section by index in the section table;
4311 any other string identifies all sections with that name in the object file.
4313 @item -R <number or name>
4314 @itemx --relocated-dump=<number or name>
4315 Displays the contents of the indicated section as a hexadecimal
4316 bytes. A number identifies a particular section by index in the
4317 section table; any other string identifies all sections with that name
4318 in the object file. The contents of the section will be relocated
4319 before they are displayed.
4321 @item -p <number or name>
4322 @itemx --string-dump=<number or name>
4323 Displays the contents of the indicated section as printable strings.
4324 A number identifies a particular section by index in the section table;
4325 any other string identifies all sections with that name in the object file.
4328 @itemx --archive-index
4329 @cindex Archive file symbol index information
4330 Displays the file symbol index information contained in the header part
4331 of binary archives. Performs the same function as the @option{t}
4332 command to @command{ar}, but without using the BFD library. @xref{ar}.
4334 @item -w[lLiaprmfFsoRt]
4335 @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]
4336 Displays the contents of the debug sections in the file, if any are
4337 present. If one of the optional letters or words follows the switch
4338 then only data found in those specific sections will be dumped.
4340 Note that there is no single letter option to display the content of
4341 trace sections or .gdb_index.
4343 Note: the @option{=decodedline} option will display the interpreted
4344 contents of a .debug_line section whereas the @option{=rawline} option
4345 dumps the contents in a raw format.
4347 Note: the @option{=frames-interp} option will display the interpreted
4348 contents of a .debug_frame section whereas the @option{=frames} option
4349 dumps the contents in a raw format.
4351 Note: the output from the @option{=info} option can also be affected
4352 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4354 @item --dwarf-depth=@var{n}
4355 Limit the dump of the @code{.debug_info} section to @var{n} children.
4356 This is only useful with @option{--debug-dump=info}. The default is
4357 to print all DIEs; the special value 0 for @var{n} will also have this
4360 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4361 levels will not be printed. The range for @var{n} is zero-based.
4363 @item --dwarf-start=@var{n}
4364 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4365 useful with @option{--debug-dump=info}.
4367 If specified, this option will suppress printing of any header
4368 information and all DIEs before the DIE numbered @var{n}. Only
4369 siblings and children of the specified DIE will be printed.
4371 This can be used in conjunction with @option{--dwarf-depth}.
4375 Display a histogram of bucket list lengths when displaying the contents
4376 of the symbol tables.
4380 Display the version number of readelf.
4384 Don't break output lines to fit into 80 columns. By default
4385 @command{readelf} breaks section header and segment listing lines for
4386 64-bit ELF files, so that they fit into 80 columns. This option causes
4387 @command{readelf} to print each section header resp. each segment one a
4388 single line, which is far more readable on terminals wider than 80 columns.
4392 Display the command line options understood by @command{readelf}.
4399 @c man begin SEEALSO readelf
4400 objdump(1), and the Info entries for @file{binutils}.
4407 @cindex Update ELF header
4410 @c man title elfedit Update the ELF header of ELF files.
4413 @c man begin SYNOPSIS elfedit
4414 elfedit [@option{--input-mach=}@var{machine}]
4415 [@option{--input-type=}@var{type}]
4416 [@option{--input-osabi=}@var{osabi}]
4417 @option{--output-mach=}@var{machine}
4418 @option{--output-type=}@var{type}
4419 @option{--output-osabi=}@var{osabi}
4420 [@option{-v}|@option{--version}]
4421 [@option{-h}|@option{--help}]
4422 @var{elffile}@dots{}
4426 @c man begin DESCRIPTION elfedit
4428 @command{elfedit} updates the ELF header of ELF files which have
4429 the matching ELF machine and file types. The options control how and
4430 which fields in the ELF header should be updated.
4432 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4433 64-bit ELF files are supported, as are archives containing ELF files.
4436 @c man begin OPTIONS elfedit
4438 The long and short forms of options, shown here as alternatives, are
4439 equivalent. At least one of the @option{--output-mach},
4440 @option{--output-type} and @option{--output-osabi} options must be given.
4444 @item --input-mach=@var{machine}
4445 Set the matching input ELF machine type to @var{machine}. If
4446 @option{--input-mach} isn't specified, it will match any ELF
4449 The supported ELF machine types are, @var{L1OM}, @var{K1OM} and
4452 @item --output-mach=@var{machine}
4453 Change the ELF machine type in the ELF header to @var{machine}. The
4454 supported ELF machine types are the same as @option{--input-mach}.
4456 @item --input-type=@var{type}
4457 Set the matching input ELF file type to @var{type}. If
4458 @option{--input-type} isn't specified, it will match any ELF file types.
4460 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4462 @item --output-type=@var{type}
4463 Change the ELF file type in the ELF header to @var{type}. The
4464 supported ELF types are the same as @option{--input-type}.
4466 @item --input-osabi=@var{osabi}
4467 Set the matching input ELF file OSABI to @var{osabi}. If
4468 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4470 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4471 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4472 @var{Solaris}, @var{AIX}, @var{Irix},
4473 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4474 @var{NSK}, @var{AROS} and @var{FenixOS}.
4476 @item --output-osabi=@var{osabi}
4477 Change the ELF OSABI in the ELF header to @var{osabi}. The
4478 supported ELF OSABI are the same as @option{--input-osabi}.
4482 Display the version number of @command{elfedit}.
4486 Display the command line options understood by @command{elfedit}.
4493 @c man begin SEEALSO elfedit
4494 readelf(1), and the Info entries for @file{binutils}.
4498 @node Common Options
4499 @chapter Common Options
4501 The following command-line options are supported by all of the
4502 programs described in this manual.
4504 @c man begin OPTIONS
4506 @include at-file.texi
4510 Display the command-line options supported by the program.
4513 Display the version number of the program.
4515 @c man begin OPTIONS
4519 @node Selecting the Target System
4520 @chapter Selecting the Target System
4522 You can specify two aspects of the target system to the @sc{gnu}
4523 binary file utilities, each in several ways:
4533 In the following summaries, the lists of ways to specify values are in
4534 order of decreasing precedence. The ways listed first override those
4537 The commands to list valid values only list the values for which the
4538 programs you are running were configured. If they were configured with
4539 @option{--enable-targets=all}, the commands list most of the available
4540 values, but a few are left out; not all targets can be configured in at
4541 once because some of them can only be configured @dfn{native} (on hosts
4542 with the same type as the target system).
4545 * Target Selection::
4546 * Architecture Selection::
4549 @node Target Selection
4550 @section Target Selection
4552 A @dfn{target} is an object file format. A given target may be
4553 supported for multiple architectures (@pxref{Architecture Selection}).
4554 A target selection may also have variations for different operating
4555 systems or architectures.
4557 The command to list valid target values is @samp{objdump -i}
4558 (the first column of output contains the relevant information).
4560 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4561 @samp{a.out-sunos-big}.
4563 You can also specify a target using a configuration triplet. This is
4564 the same sort of name that is passed to @file{configure} to specify a
4565 target. When you use a configuration triplet as an argument, it must be
4566 fully canonicalized. You can see the canonical version of a triplet by
4567 running the shell script @file{config.sub} which is included with the
4570 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4571 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4573 @subheading @command{objdump} Target
4579 command line option: @option{-b} or @option{--target}
4582 environment variable @code{GNUTARGET}
4585 deduced from the input file
4588 @subheading @command{objcopy} and @command{strip} Input Target
4594 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4597 environment variable @code{GNUTARGET}
4600 deduced from the input file
4603 @subheading @command{objcopy} and @command{strip} Output Target
4609 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4612 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4615 environment variable @code{GNUTARGET}
4618 deduced from the input file
4621 @subheading @command{nm}, @command{size}, and @command{strings} Target
4627 command line option: @option{--target}
4630 environment variable @code{GNUTARGET}
4633 deduced from the input file
4636 @node Architecture Selection
4637 @section Architecture Selection
4639 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4640 to run. Its name may contain a colon, separating the name of the
4641 processor family from the name of the particular @sc{cpu}.
4643 The command to list valid architecture values is @samp{objdump -i} (the
4644 second column contains the relevant information).
4646 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4648 @subheading @command{objdump} Architecture
4654 command line option: @option{-m} or @option{--architecture}
4657 deduced from the input file
4660 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4666 deduced from the input file
4669 @node Reporting Bugs
4670 @chapter Reporting Bugs
4672 @cindex reporting bugs
4674 Your bug reports play an essential role in making the binary utilities
4677 Reporting a bug may help you by bringing a solution to your problem, or
4678 it may not. But in any case the principal function of a bug report is
4679 to help the entire community by making the next version of the binary
4680 utilities work better. Bug reports are your contribution to their
4683 In order for a bug report to serve its purpose, you must include the
4684 information that enables us to fix the bug.
4687 * Bug Criteria:: Have you found a bug?
4688 * Bug Reporting:: How to report bugs
4692 @section Have You Found a Bug?
4693 @cindex bug criteria
4695 If you are not sure whether you have found a bug, here are some guidelines:
4698 @cindex fatal signal
4701 If a binary utility gets a fatal signal, for any input whatever, that is
4702 a bug. Reliable utilities never crash.
4704 @cindex error on valid input
4706 If a binary utility produces an error message for valid input, that is a
4710 If you are an experienced user of binary utilities, your suggestions for
4711 improvement are welcome in any case.
4715 @section How to Report Bugs
4717 @cindex bugs, reporting
4719 A number of companies and individuals offer support for @sc{gnu}
4720 products. If you obtained the binary utilities from a support
4721 organization, we recommend you contact that organization first.
4723 You can find contact information for many support companies and
4724 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4728 In any event, we also recommend that you send bug reports for the binary
4729 utilities to @value{BUGURL}.
4732 The fundamental principle of reporting bugs usefully is this:
4733 @strong{report all the facts}. If you are not sure whether to state a
4734 fact or leave it out, state it!
4736 Often people omit facts because they think they know what causes the
4737 problem and assume that some details do not matter. Thus, you might
4738 assume that the name of a file you use in an example does not matter.
4739 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4740 a stray memory reference which happens to fetch from the location where
4741 that pathname is stored in memory; perhaps, if the pathname were
4742 different, the contents of that location would fool the utility into
4743 doing the right thing despite the bug. Play it safe and give a
4744 specific, complete example. That is the easiest thing for you to do,
4745 and the most helpful.
4747 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4748 it is new to us. Therefore, always write your bug reports on the assumption
4749 that the bug has not been reported previously.
4751 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4752 bell?'' This cannot help us fix a bug, so it is basically useless. We
4753 respond by asking for enough details to enable us to investigate.
4754 You might as well expedite matters by sending them to begin with.
4756 To enable us to fix the bug, you should include all these things:
4760 The version of the utility. Each utility announces it if you start it
4761 with the @option{--version} argument.
4763 Without this, we will not know whether there is any point in looking for
4764 the bug in the current version of the binary utilities.
4767 Any patches you may have applied to the source, including any patches
4768 made to the @code{BFD} library.
4771 The type of machine you are using, and the operating system name and
4775 What compiler (and its version) was used to compile the utilities---e.g.
4779 The command arguments you gave the utility to observe the bug. To
4780 guarantee you will not omit something important, list them all. A copy
4781 of the Makefile (or the output from make) is sufficient.
4783 If we were to try to guess the arguments, we would probably guess wrong
4784 and then we might not encounter the bug.
4787 A complete input file, or set of input files, that will reproduce the
4788 bug. If the utility is reading an object file or files, then it is
4789 generally most helpful to send the actual object files.
4791 If the source files were produced exclusively using @sc{gnu} programs
4792 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4793 may be OK to send the source files rather than the object files. In
4794 this case, be sure to say exactly what version of @command{gcc}, or
4795 whatever, was used to produce the object files. Also say how
4796 @command{gcc}, or whatever, was configured.
4799 A description of what behavior you observe that you believe is
4800 incorrect. For example, ``It gets a fatal signal.''
4802 Of course, if the bug is that the utility gets a fatal signal, then we
4803 will certainly notice it. But if the bug is incorrect output, we might
4804 not notice unless it is glaringly wrong. You might as well not give us
4805 a chance to make a mistake.
4807 Even if the problem you experience is a fatal signal, you should still
4808 say so explicitly. Suppose something strange is going on, such as your
4809 copy of the utility is out of sync, or you have encountered a bug in
4810 the C library on your system. (This has happened!) Your copy might
4811 crash and ours would not. If you told us to expect a crash, then when
4812 ours fails to crash, we would know that the bug was not happening for
4813 us. If you had not told us to expect a crash, then we would not be able
4814 to draw any conclusion from our observations.
4817 If you wish to suggest changes to the source, send us context diffs, as
4818 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4819 option. Always send diffs from the old file to the new file. If you
4820 wish to discuss something in the @command{ld} source, refer to it by
4821 context, not by line number.
4823 The line numbers in our development sources will not match those in your
4824 sources. Your line numbers would convey no useful information to us.
4827 Here are some things that are not necessary:
4831 A description of the envelope of the bug.
4833 Often people who encounter a bug spend a lot of time investigating
4834 which changes to the input file will make the bug go away and which
4835 changes will not affect it.
4837 This is often time consuming and not very useful, because the way we
4838 will find the bug is by running a single example under the debugger
4839 with breakpoints, not by pure deduction from a series of examples.
4840 We recommend that you save your time for something else.
4842 Of course, if you can find a simpler example to report @emph{instead}
4843 of the original one, that is a convenience for us. Errors in the
4844 output will be easier to spot, running under the debugger will take
4845 less time, and so on.
4847 However, simplification is not vital; if you do not want to do this,
4848 report the bug anyway and send us the entire test case you used.
4851 A patch for the bug.
4853 A patch for the bug does help us if it is a good one. But do not omit
4854 the necessary information, such as the test case, on the assumption that
4855 a patch is all we need. We might see problems with your patch and decide
4856 to fix the problem another way, or we might not understand it at all.
4858 Sometimes with programs as complicated as the binary utilities it is
4859 very hard to construct an example that will make the program follow a
4860 certain path through the code. If you do not send us the example, we
4861 will not be able to construct one, so we will not be able to verify that
4864 And if we cannot understand what bug you are trying to fix, or why your
4865 patch should be an improvement, we will not install it. A test case will
4866 help us to understand.
4869 A guess about what the bug is or what it depends on.
4871 Such guesses are usually wrong. Even we cannot guess right about such
4872 things without first using the debugger to find the facts.
4875 @node GNU Free Documentation License
4876 @appendix GNU Free Documentation License
4880 @node Binutils Index
4881 @unnumbered Binutils Index