1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2014 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 [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @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{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @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{--dump-section} @var{sectionname}=@var{filename}]
1093 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1094 [@option{--long-section-names} @{enable,disable,keep@}]
1095 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1096 [@option{--reverse-bytes=}@var{num}]
1097 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1098 [@option{--redefine-sym} @var{old}=@var{new}]
1099 [@option{--redefine-syms=}@var{filename}]
1101 [@option{--keep-symbols=}@var{filename}]
1102 [@option{--strip-symbols=}@var{filename}]
1103 [@option{--strip-unneeded-symbols=}@var{filename}]
1104 [@option{--keep-global-symbols=}@var{filename}]
1105 [@option{--localize-symbols=}@var{filename}]
1106 [@option{--globalize-symbols=}@var{filename}]
1107 [@option{--weaken-symbols=}@var{filename}]
1108 [@option{--alt-machine-code=}@var{index}]
1109 [@option{--prefix-symbols=}@var{string}]
1110 [@option{--prefix-sections=}@var{string}]
1111 [@option{--prefix-alloc-sections=}@var{string}]
1112 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1113 [@option{--keep-file-symbols}]
1114 [@option{--only-keep-debug}]
1115 [@option{--strip-dwo}]
1116 [@option{--extract-dwo}]
1117 [@option{--extract-symbol}]
1118 [@option{--writable-text}]
1119 [@option{--readonly-text}]
1122 [@option{--file-alignment=}@var{num}]
1123 [@option{--heap=}@var{size}]
1124 [@option{--image-base=}@var{address}]
1125 [@option{--section-alignment=}@var{num}]
1126 [@option{--stack=}@var{size}]
1127 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1128 [@option{--compress-debug-sections}]
1129 [@option{--decompress-debug-sections}]
1130 [@option{--dwarf-depth=@var{n}}]
1131 [@option{--dwarf-start=@var{n}}]
1132 [@option{-v}|@option{--verbose}]
1133 [@option{-V}|@option{--version}]
1134 [@option{--help}] [@option{--info}]
1135 @var{infile} [@var{outfile}]
1139 @c man begin DESCRIPTION objcopy
1140 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1141 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1142 read and write the object files. It can write the destination object
1143 file in a format different from that of the source object file. The
1144 exact behavior of @command{objcopy} is controlled by command-line options.
1145 Note that @command{objcopy} should be able to copy a fully linked file
1146 between any two formats. However, copying a relocatable object file
1147 between any two formats may not work as expected.
1149 @command{objcopy} creates temporary files to do its translations and
1150 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1151 translation work; it has access to all the formats described in @sc{bfd}
1152 and thus is able to recognize most formats without being told
1153 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1155 @command{objcopy} can be used to generate S-records by using an output
1156 target of @samp{srec} (e.g., use @samp{-O srec}).
1158 @command{objcopy} can be used to generate a raw binary file by using an
1159 output target of @samp{binary} (e.g., use @option{-O binary}). When
1160 @command{objcopy} generates a raw binary file, it will essentially produce
1161 a memory dump of the contents of the input object file. All symbols and
1162 relocation information will be discarded. The memory dump will start at
1163 the load address of the lowest section copied into the output file.
1165 When generating an S-record or a raw binary file, it may be helpful to
1166 use @option{-S} to remove sections containing debugging information. In
1167 some cases @option{-R} will be useful to remove sections which contain
1168 information that is not needed by the binary file.
1170 Note---@command{objcopy} is not able to change the endianness of its input
1171 files. If the input format has an endianness (some formats do not),
1172 @command{objcopy} can only copy the inputs into file formats that have the
1173 same endianness or which have no endianness (e.g., @samp{srec}).
1174 (However, see the @option{--reverse-bytes} option.)
1178 @c man begin OPTIONS objcopy
1182 @itemx @var{outfile}
1183 The input and output files, respectively.
1184 If you do not specify @var{outfile}, @command{objcopy} creates a
1185 temporary file and destructively renames the result with
1186 the name of @var{infile}.
1188 @item -I @var{bfdname}
1189 @itemx --input-target=@var{bfdname}
1190 Consider the source file's object format to be @var{bfdname}, rather than
1191 attempting to deduce it. @xref{Target Selection}, for more information.
1193 @item -O @var{bfdname}
1194 @itemx --output-target=@var{bfdname}
1195 Write the output file using the object format @var{bfdname}.
1196 @xref{Target Selection}, for more information.
1198 @item -F @var{bfdname}
1199 @itemx --target=@var{bfdname}
1200 Use @var{bfdname} as the object format for both the input and the output
1201 file; i.e., simply transfer data from source to destination with no
1202 translation. @xref{Target Selection}, for more information.
1204 @item -B @var{bfdarch}
1205 @itemx --binary-architecture=@var{bfdarch}
1206 Useful when transforming a architecture-less input file into an object file.
1207 In this case the output architecture can be set to @var{bfdarch}. This
1208 option will be ignored if the input file has a known @var{bfdarch}. You
1209 can access this binary data inside a program by referencing the special
1210 symbols that are created by the conversion process. These symbols are
1211 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1212 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1213 an object file and then access it in your code using these symbols.
1215 @item -j @var{sectionpattern}
1216 @itemx --only-section=@var{sectionpattern}
1217 Copy only the indicated sections from the input file to the output file.
1218 This option may be given more than once. Note that using this option
1219 inappropriately may make the output file unusable. Wildcard
1220 characters are accepted in @var{sectionpattern}.
1222 @item -R @var{sectionpattern}
1223 @itemx --remove-section=@var{sectionpattern}
1224 Remove any section matching @var{sectionpattern} from the output file.
1225 This option may be given more than once. Note that using this option
1226 inappropriately may make the output file unusable. Wildcard
1227 characters are accepted in @var{sectionpattern}. Using both the
1228 @option{-j} and @option{-R} options together results in undefined
1233 Do not copy relocation and symbol information from the source file.
1236 @itemx --strip-debug
1237 Do not copy debugging symbols or sections from the source file.
1239 @item --strip-unneeded
1240 Strip all symbols that are not needed for relocation processing.
1242 @item -K @var{symbolname}
1243 @itemx --keep-symbol=@var{symbolname}
1244 When stripping symbols, keep symbol @var{symbolname} even if it would
1245 normally be stripped. This option may be given more than once.
1247 @item -N @var{symbolname}
1248 @itemx --strip-symbol=@var{symbolname}
1249 Do not copy symbol @var{symbolname} from the source file. This option
1250 may be given more than once.
1252 @item --strip-unneeded-symbol=@var{symbolname}
1253 Do not copy symbol @var{symbolname} from the source file unless it is needed
1254 by a relocation. This option may be given more than once.
1256 @item -G @var{symbolname}
1257 @itemx --keep-global-symbol=@var{symbolname}
1258 Keep only symbol @var{symbolname} global. Make all other symbols local
1259 to the file, so that they are not visible externally. This option may
1260 be given more than once.
1262 @item --localize-hidden
1263 In an ELF object, mark all symbols that have hidden or internal visibility
1264 as local. This option applies on top of symbol-specific localization options
1265 such as @option{-L}.
1267 @item -L @var{symbolname}
1268 @itemx --localize-symbol=@var{symbolname}
1269 Make symbol @var{symbolname} local to the file, so that it is not
1270 visible externally. This option may be given more than once.
1272 @item -W @var{symbolname}
1273 @itemx --weaken-symbol=@var{symbolname}
1274 Make symbol @var{symbolname} weak. This option may be given more than once.
1276 @item --globalize-symbol=@var{symbolname}
1277 Give symbol @var{symbolname} global scoping so that it is visible
1278 outside of the file in which it is defined. This option may be given
1283 Permit regular expressions in @var{symbolname}s used in other command
1284 line options. The question mark (?), asterisk (*), backslash (\) and
1285 square brackets ([]) operators can be used anywhere in the symbol
1286 name. If the first character of the symbol name is the exclamation
1287 point (!) then the sense of the switch is reversed for that symbol.
1294 would cause objcopy to weaken all symbols that start with ``fo''
1295 except for the symbol ``foo''.
1298 @itemx --discard-all
1299 Do not copy non-global symbols from the source file.
1300 @c FIXME any reason to prefer "non-global" to "local" here?
1303 @itemx --discard-locals
1304 Do not copy compiler-generated local symbols.
1305 (These usually start with @samp{L} or @samp{.}.)
1308 @itemx --byte=@var{byte}
1309 If interleaving has been enabled via the @option{--interleave} option
1310 then start the range of bytes to keep at the @var{byte}th byte.
1311 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1312 @var{breadth} is the value given by the @option{--interleave} option.
1314 @item -i [@var{breadth}]
1315 @itemx --interleave[=@var{breadth}]
1316 Only copy a range out of every @var{breadth} bytes. (Header data is
1317 not affected). Select which byte in the range begins the copy with
1318 the @option{--byte} option. Select the width of the range with the
1319 @option{--interleave-width} option.
1321 This option is useful for creating files to program @sc{rom}. It is
1322 typically used with an @code{srec} output target. Note that
1323 @command{objcopy} will complain if you do not specify the
1324 @option{--byte} option as well.
1326 The default interleave breadth is 4, so with @option{--byte} set to 0,
1327 @command{objcopy} would copy the first byte out of every four bytes
1328 from the input to the output.
1330 @item --interleave-width=@var{width}
1331 When used with the @option{--interleave} option, copy @var{width}
1332 bytes at a time. The start of the range of bytes to be copied is set
1333 by the @option{--byte} option, and the extent of the range is set with
1334 the @option{--interleave} option.
1336 The default value for this option is 1. The value of @var{width} plus
1337 the @var{byte} value set by the @option{--byte} option must not exceed
1338 the interleave breadth set by the @option{--interleave} option.
1340 This option can be used to create images for two 16-bit flashes interleaved
1341 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1342 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1343 commands. If the input was '12345678' then the outputs would be
1344 '1256' and '3478' respectively.
1347 @itemx --preserve-dates
1348 Set the access and modification dates of the output file to be the same
1349 as those of the input file.
1352 @itemx --enable-deterministic-archives
1353 @cindex deterministic archives
1354 @kindex --enable-deterministic-archives
1355 Operate in @emph{deterministic} mode. When copying archive members
1356 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1357 and use consistent file modes for all files.
1359 If @file{binutils} was configured with
1360 @option{--enable-deterministic-archives}, then this mode is on by default.
1361 It can be disabled with the @samp{-U} option, below.
1364 @itemx --disable-deterministic-archives
1365 @cindex deterministic archives
1366 @kindex --enable-deterministic-archives
1367 Do @emph{not} operate in @emph{deterministic} mode. This is the
1368 inverse of the @option{-D} option, above: when copying archive members
1369 and writing the archive index, use their actual UID, GID, timestamp,
1370 and file mode values.
1372 This is the default unless @file{binutils} was configured with
1373 @option{--enable-deterministic-archives}.
1376 Convert debugging information, if possible. This is not the default
1377 because only certain debugging formats are supported, and the
1378 conversion process can be time consuming.
1380 @item --gap-fill @var{val}
1381 Fill gaps between sections with @var{val}. This operation applies to
1382 the @emph{load address} (LMA) of the sections. It is done by increasing
1383 the size of the section with the lower address, and filling in the extra
1384 space created with @var{val}.
1386 @item --pad-to @var{address}
1387 Pad the output file up to the load address @var{address}. This is
1388 done by increasing the size of the last section. The extra space is
1389 filled in with the value specified by @option{--gap-fill} (default zero).
1391 @item --set-start @var{val}
1392 Set the start address of the new file to @var{val}. Not all object file
1393 formats support setting the start address.
1395 @item --change-start @var{incr}
1396 @itemx --adjust-start @var{incr}
1397 @cindex changing start address
1398 Change the start address by adding @var{incr}. Not all object file
1399 formats support setting the start address.
1401 @item --change-addresses @var{incr}
1402 @itemx --adjust-vma @var{incr}
1403 @cindex changing object addresses
1404 Change the VMA and LMA addresses of all sections, as well as the start
1405 address, by adding @var{incr}. Some object file formats do not permit
1406 section addresses to be changed arbitrarily. Note that this does not
1407 relocate the sections; if the program expects sections to be loaded at a
1408 certain address, and this option is used to change the sections such
1409 that they are loaded at a different address, the program may fail.
1411 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1412 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1413 @cindex changing section address
1414 Set or change both the VMA address and the LMA address of any section
1415 matching @var{sectionpattern}. If @samp{=} is used, the section
1416 address is set to @var{val}. Otherwise, @var{val} is added to or
1417 subtracted from the section address. See the comments under
1418 @option{--change-addresses}, above. If @var{sectionpattern} does not
1419 match any sections in the input file, a warning will be issued, unless
1420 @option{--no-change-warnings} is used.
1422 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1423 @cindex changing section LMA
1424 Set or change the LMA address of any sections matching
1425 @var{sectionpattern}. The LMA address is the address where the
1426 section will be loaded into memory at program load time. Normally
1427 this is the same as the VMA address, which is the address of the
1428 section at program run time, but on some systems, especially those
1429 where a program is held in ROM, the two can be different. If @samp{=}
1430 is used, the section address is set to @var{val}. Otherwise,
1431 @var{val} is added to or subtracted from the section address. See the
1432 comments under @option{--change-addresses}, above. If
1433 @var{sectionpattern} does not match any sections in the input file, a
1434 warning will be issued, unless @option{--no-change-warnings} is used.
1436 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1437 @cindex changing section VMA
1438 Set or change the VMA address of any section matching
1439 @var{sectionpattern}. The VMA address is the address where the
1440 section will be located once the program has started executing.
1441 Normally this is the same as the LMA address, which is the address
1442 where the section will be loaded into memory, but on some systems,
1443 especially those where a program is held in ROM, the two can be
1444 different. If @samp{=} is used, the section address is set to
1445 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1446 section address. See the comments under @option{--change-addresses},
1447 above. If @var{sectionpattern} does not match any sections in the
1448 input file, a warning will be issued, unless
1449 @option{--no-change-warnings} is used.
1451 @item --change-warnings
1452 @itemx --adjust-warnings
1453 If @option{--change-section-address} or @option{--change-section-lma} or
1454 @option{--change-section-vma} is used, and the section pattern does not
1455 match any sections, issue a warning. This is the default.
1457 @item --no-change-warnings
1458 @itemx --no-adjust-warnings
1459 Do not issue a warning if @option{--change-section-address} or
1460 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1461 if the section pattern does not match any sections.
1463 @item --set-section-flags @var{sectionpattern}=@var{flags}
1464 Set the flags for any sections matching @var{sectionpattern}. The
1465 @var{flags} argument is a comma separated string of flag names. The
1466 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1467 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1468 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1469 for a section which does not have contents, but it is not meaningful
1470 to clear the @samp{contents} flag of a section which does have
1471 contents--just remove the section instead. Not all flags are
1472 meaningful for all object file formats.
1474 @item --add-section @var{sectionname}=@var{filename}
1475 Add a new section named @var{sectionname} while copying the file. The
1476 contents of the new section are taken from the file @var{filename}. The
1477 size of the section will be the size of the file. This option only
1478 works on file formats which can support sections with arbitrary names.
1479 Note - it may be necessary to use the @option{--set-section-flags}
1480 option to set the attributes of the newly created section.
1482 @item --dump-section @var{sectionname}=@var{filename}
1483 Place the contents of section named @var{sectionname} into the file
1484 @var{filename}, overwriting any contents that may have been there
1485 previously. This option is the inverse of @option{--add-section}.
1486 This option is similar to the @option{--only-section} option except
1487 that it does not create a formatted file, it just dumps the contents
1488 as raw binary data, without applying any relocations. The option can
1489 be specified more than once.
1491 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1492 Rename a section from @var{oldname} to @var{newname}, optionally
1493 changing the section's flags to @var{flags} in the process. This has
1494 the advantage over usng a linker script to perform the rename in that
1495 the output stays as an object file and does not become a linked
1498 This option is particularly helpful when the input format is binary,
1499 since this will always create a section called .data. If for example,
1500 you wanted instead to create a section called .rodata containing binary
1501 data you could use the following command line to achieve it:
1504 objcopy -I binary -O <output_format> -B <architecture> \
1505 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1506 <input_binary_file> <output_object_file>
1509 @item --long-section-names @{enable,disable,keep@}
1510 Controls the handling of long section names when processing @code{COFF}
1511 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1512 is to preserve long section names if any are present in the input file.
1513 The @samp{enable} and @samp{disable} options forcibly enable or disable
1514 the use of long section names in the output object; when @samp{disable}
1515 is in effect, any long section names in the input object will be truncated.
1516 The @samp{enable} option will only emit long section names if any are
1517 present in the inputs; this is mostly the same as @samp{keep}, but it
1518 is left undefined whether the @samp{enable} option might force the
1519 creation of an empty string table in the output file.
1521 @item --change-leading-char
1522 Some object file formats use special characters at the start of
1523 symbols. The most common such character is underscore, which compilers
1524 often add before every symbol. This option tells @command{objcopy} to
1525 change the leading character of every symbol when it converts between
1526 object file formats. If the object file formats use the same leading
1527 character, this option has no effect. Otherwise, it will add a
1528 character, or remove a character, or change a character, as
1531 @item --remove-leading-char
1532 If the first character of a global symbol is a special symbol leading
1533 character used by the object file format, remove the character. The
1534 most common symbol leading character is underscore. This option will
1535 remove a leading underscore from all global symbols. This can be useful
1536 if you want to link together objects of different file formats with
1537 different conventions for symbol names. This is different from
1538 @option{--change-leading-char} because it always changes the symbol name
1539 when appropriate, regardless of the object file format of the output
1542 @item --reverse-bytes=@var{num}
1543 Reverse the bytes in a section with output contents. A section length must
1544 be evenly divisible by the value given in order for the swap to be able to
1545 take place. Reversing takes place before the interleaving is performed.
1547 This option is used typically in generating ROM images for problematic
1548 target systems. For example, on some target boards, the 32-bit words
1549 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1550 regardless of the CPU byte order. Depending on the programming model, the
1551 endianness of the ROM may need to be modified.
1553 Consider a simple file with a section containing the following eight
1554 bytes: @code{12345678}.
1556 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1557 output file would be ordered @code{21436587}.
1559 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1560 output file would be ordered @code{43218765}.
1562 By using @samp{--reverse-bytes=2} for the above example, followed by
1563 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1564 output file would be ordered @code{34127856}.
1566 @item --srec-len=@var{ival}
1567 Meaningful only for srec output. Set the maximum length of the Srecords
1568 being produced to @var{ival}. This length covers both address, data and
1571 @item --srec-forceS3
1572 Meaningful only for srec output. Avoid generation of S1/S2 records,
1573 creating S3-only record format.
1575 @item --redefine-sym @var{old}=@var{new}
1576 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1577 when one is trying link two things together for which you have no
1578 source, and there are name collisions.
1580 @item --redefine-syms=@var{filename}
1581 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1582 listed in the file @var{filename}. @var{filename} is simply a flat file,
1583 with one symbol pair per line. Line comments may be introduced by the hash
1584 character. This option may be given more than once.
1587 Change all global symbols in the file to be weak. This can be useful
1588 when building an object which will be linked against other objects using
1589 the @option{-R} option to the linker. This option is only effective when
1590 using an object file format which supports weak symbols.
1592 @item --keep-symbols=@var{filename}
1593 Apply @option{--keep-symbol} option to each symbol listed in the file
1594 @var{filename}. @var{filename} is simply a flat file, with one symbol
1595 name per line. Line comments may be introduced by the hash character.
1596 This option may be given more than once.
1598 @item --strip-symbols=@var{filename}
1599 Apply @option{--strip-symbol} option to each symbol listed in the file
1600 @var{filename}. @var{filename} is simply a flat file, with one symbol
1601 name per line. Line comments may be introduced by the hash character.
1602 This option may be given more than once.
1604 @item --strip-unneeded-symbols=@var{filename}
1605 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1606 the file @var{filename}. @var{filename} is simply a flat file, with one
1607 symbol name per line. Line comments may be introduced by the hash
1608 character. This option may be given more than once.
1610 @item --keep-global-symbols=@var{filename}
1611 Apply @option{--keep-global-symbol} option to each symbol listed in the
1612 file @var{filename}. @var{filename} is simply a flat file, with one
1613 symbol name per line. Line comments may be introduced by the hash
1614 character. This option may be given more than once.
1616 @item --localize-symbols=@var{filename}
1617 Apply @option{--localize-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 --globalize-symbols=@var{filename}
1623 Apply @option{--globalize-symbol} option to each symbol listed in the file
1624 @var{filename}. @var{filename} is simply a flat file, with one symbol
1625 name per line. Line comments may be introduced by the hash character.
1626 This option may be given more than once.
1628 @item --weaken-symbols=@var{filename}
1629 Apply @option{--weaken-symbol} option to each symbol listed in the file
1630 @var{filename}. @var{filename} is simply a flat file, with one symbol
1631 name per line. Line comments may be introduced by the hash character.
1632 This option may be given more than once.
1634 @item --alt-machine-code=@var{index}
1635 If the output architecture has alternate machine codes, use the
1636 @var{index}th code instead of the default one. This is useful in case
1637 a machine is assigned an official code and the tool-chain adopts the
1638 new code, but other applications still depend on the original code
1639 being used. For ELF based architectures if the @var{index}
1640 alternative does not exist then the value is treated as an absolute
1641 number to be stored in the e_machine field of the ELF header.
1643 @item --writable-text
1644 Mark the output text as writable. This option isn't meaningful for all
1645 object file formats.
1647 @item --readonly-text
1648 Make the output text write protected. This option isn't meaningful for all
1649 object file formats.
1652 Mark the output file as demand paged. This option isn't meaningful for all
1653 object file formats.
1656 Mark the output file as impure. This option isn't meaningful for all
1657 object file formats.
1659 @item --prefix-symbols=@var{string}
1660 Prefix all symbols in the output file with @var{string}.
1662 @item --prefix-sections=@var{string}
1663 Prefix all section names in the output file with @var{string}.
1665 @item --prefix-alloc-sections=@var{string}
1666 Prefix all the names of all allocated sections in the output file with
1669 @item --add-gnu-debuglink=@var{path-to-file}
1670 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1671 and adds it to the output file.
1673 @item --keep-file-symbols
1674 When stripping a file, perhaps with @option{--strip-debug} or
1675 @option{--strip-unneeded}, retain any symbols specifying source file names,
1676 which would otherwise get stripped.
1678 @item --only-keep-debug
1679 Strip a file, removing contents of any sections that would not be
1680 stripped by @option{--strip-debug} and leaving the debugging sections
1681 intact. In ELF files, this preserves all note sections in the output.
1683 The intention is that this option will be used in conjunction with
1684 @option{--add-gnu-debuglink} to create a two part executable. One a
1685 stripped binary which will occupy less space in RAM and in a
1686 distribution and the second a debugging information file which is only
1687 needed if debugging abilities are required. The suggested procedure
1688 to create these files is as follows:
1691 @item Link the executable as normal. Assuming that is is called
1693 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1694 create a file containing the debugging info.
1695 @item Run @code{objcopy --strip-debug foo} to create a
1696 stripped executable.
1697 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1698 to add a link to the debugging info into the stripped executable.
1701 Note---the choice of @code{.dbg} as an extension for the debug info
1702 file is arbitrary. Also the @code{--only-keep-debug} step is
1703 optional. You could instead do this:
1706 @item Link the executable as normal.
1707 @item Copy @code{foo} to @code{foo.full}
1708 @item Run @code{objcopy --strip-debug foo}
1709 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1712 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1713 full executable. It does not have to be a file created by the
1714 @option{--only-keep-debug} switch.
1716 Note---this switch is only intended for use on fully linked files. It
1717 does not make sense to use it on object files where the debugging
1718 information may be incomplete. Besides the gnu_debuglink feature
1719 currently only supports the presence of one filename containing
1720 debugging information, not multiple filenames on a one-per-object-file
1724 Remove the contents of all DWARF .dwo sections, leaving the
1725 remaining debugging sections and all symbols intact.
1726 This option is intended for use by the compiler as part of
1727 the @option{-gsplit-dwarf} option, which splits debug information
1728 between the .o file and a separate .dwo file. The compiler
1729 generates all debug information in the same file, then uses
1730 the @option{--extract-dwo} option to copy the .dwo sections to
1731 the .dwo file, then the @option{--strip-dwo} option to remove
1732 those sections from the original .o file.
1735 Extract the contents of all DWARF .dwo sections. See the
1736 @option{--strip-dwo} option for more information.
1738 @item --file-alignment @var{num}
1739 Specify the file alignment. Sections in the file will always begin at
1740 file offsets which are multiples of this number. This defaults to
1742 [This option is specific to PE targets.]
1744 @item --heap @var{reserve}
1745 @itemx --heap @var{reserve},@var{commit}
1746 Specify the number of bytes of memory to reserve (and optionally commit)
1747 to be used as heap for this program.
1748 [This option is specific to PE targets.]
1750 @item --image-base @var{value}
1751 Use @var{value} as the base address of your program or dll. This is
1752 the lowest memory location that will be used when your program or dll
1753 is loaded. To reduce the need to relocate and improve performance of
1754 your dlls, each should have a unique base address and not overlap any
1755 other dlls. The default is 0x400000 for executables, and 0x10000000
1757 [This option is specific to PE targets.]
1759 @item --section-alignment @var{num}
1760 Sets the section alignment. Sections in memory will always begin at
1761 addresses which are a multiple of this number. Defaults to 0x1000.
1762 [This option is specific to PE targets.]
1764 @item --stack @var{reserve}
1765 @itemx --stack @var{reserve},@var{commit}
1766 Specify the number of bytes of memory to reserve (and optionally commit)
1767 to be used as stack for this program.
1768 [This option is specific to PE targets.]
1770 @item --subsystem @var{which}
1771 @itemx --subsystem @var{which}:@var{major}
1772 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1773 Specifies the subsystem under which your program will execute. The
1774 legal values for @var{which} are @code{native}, @code{windows},
1775 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1776 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1777 the subsystem version also. Numeric values are also accepted for
1779 [This option is specific to PE targets.]
1781 @item --extract-symbol
1782 Keep the file's section flags and symbols but remove all section data.
1783 Specifically, the option:
1786 @item removes the contents of all sections;
1787 @item sets the size of every section to zero; and
1788 @item sets the file's start address to zero.
1791 This option is used to build a @file{.sym} file for a VxWorks kernel.
1792 It can also be a useful way of reducing the size of a @option{--just-symbols}
1795 @item --compress-debug-sections
1796 Compress DWARF debug sections using zlib.
1798 @item --decompress-debug-sections
1799 Decompress DWARF debug sections using zlib.
1803 Show the version number of @command{objcopy}.
1807 Verbose output: list all object files modified. In the case of
1808 archives, @samp{objcopy -V} lists all members of the archive.
1811 Show a summary of the options to @command{objcopy}.
1814 Display a list showing all architectures and object formats available.
1820 @c man begin SEEALSO objcopy
1821 ld(1), objdump(1), and the Info entries for @file{binutils}.
1828 @cindex object file information
1831 @c man title objdump display information from object files.
1834 @c man begin SYNOPSIS objdump
1835 objdump [@option{-a}|@option{--archive-headers}]
1836 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1837 [@option{-C}|@option{--demangle}[=@var{style}] ]
1838 [@option{-d}|@option{--disassemble}]
1839 [@option{-D}|@option{--disassemble-all}]
1840 [@option{-z}|@option{--disassemble-zeroes}]
1841 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1842 [@option{-f}|@option{--file-headers}]
1843 [@option{-F}|@option{--file-offsets}]
1844 [@option{--file-start-context}]
1845 [@option{-g}|@option{--debugging}]
1846 [@option{-e}|@option{--debugging-tags}]
1847 [@option{-h}|@option{--section-headers}|@option{--headers}]
1848 [@option{-i}|@option{--info}]
1849 [@option{-j} @var{section}|@option{--section=}@var{section}]
1850 [@option{-l}|@option{--line-numbers}]
1851 [@option{-S}|@option{--source}]
1852 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1853 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1854 [@option{-p}|@option{--private-headers}]
1855 [@option{-P} @var{options}|@option{--private=}@var{options}]
1856 [@option{-r}|@option{--reloc}]
1857 [@option{-R}|@option{--dynamic-reloc}]
1858 [@option{-s}|@option{--full-contents}]
1859 [@option{-W[lLiaprmfFsoRt]}|
1860 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
1861 [@option{-G}|@option{--stabs}]
1862 [@option{-t}|@option{--syms}]
1863 [@option{-T}|@option{--dynamic-syms}]
1864 [@option{-x}|@option{--all-headers}]
1865 [@option{-w}|@option{--wide}]
1866 [@option{--start-address=}@var{address}]
1867 [@option{--stop-address=}@var{address}]
1868 [@option{--prefix-addresses}]
1869 [@option{--[no-]show-raw-insn}]
1870 [@option{--adjust-vma=}@var{offset}]
1871 [@option{--special-syms}]
1872 [@option{--prefix=}@var{prefix}]
1873 [@option{--prefix-strip=}@var{level}]
1874 [@option{--insn-width=}@var{width}]
1875 [@option{-V}|@option{--version}]
1876 [@option{-H}|@option{--help}]
1877 @var{objfile}@dots{}
1881 @c man begin DESCRIPTION objdump
1883 @command{objdump} displays information about one or more object files.
1884 The options control what particular information to display. This
1885 information is mostly useful to programmers who are working on the
1886 compilation tools, as opposed to programmers who just want their
1887 program to compile and work.
1889 @var{objfile}@dots{} are the object files to be examined. When you
1890 specify archives, @command{objdump} shows information on each of the member
1895 @c man begin OPTIONS objdump
1897 The long and short forms of options, shown here as alternatives, are
1898 equivalent. At least one option from the list
1899 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1903 @itemx --archive-header
1904 @cindex archive headers
1905 If any of the @var{objfile} files are archives, display the archive
1906 header information (in a format similar to @samp{ls -l}). Besides the
1907 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1908 the object file format of each archive member.
1910 @item --adjust-vma=@var{offset}
1911 @cindex section addresses in objdump
1912 @cindex VMA in objdump
1913 When dumping information, first add @var{offset} to all the section
1914 addresses. This is useful if the section addresses do not correspond to
1915 the symbol table, which can happen when putting sections at particular
1916 addresses when using a format which can not represent section addresses,
1919 @item -b @var{bfdname}
1920 @itemx --target=@var{bfdname}
1921 @cindex object code format
1922 Specify that the object-code format for the object files is
1923 @var{bfdname}. This option may not be necessary; @var{objdump} can
1924 automatically recognize many formats.
1928 objdump -b oasys -m vax -h fu.o
1931 displays summary information from the section headers (@option{-h}) of
1932 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1933 file in the format produced by Oasys compilers. You can list the
1934 formats available with the @option{-i} option.
1935 @xref{Target Selection}, for more information.
1938 @itemx --demangle[=@var{style}]
1939 @cindex demangling in objdump
1940 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1941 Besides removing any initial underscore prepended by the system, this
1942 makes C++ function names readable. Different compilers have different
1943 mangling styles. The optional demangling style argument can be used to
1944 choose an appropriate demangling style for your compiler. @xref{c++filt},
1945 for more information on demangling.
1949 Display debugging information. This attempts to parse STABS and IEEE
1950 debugging format information stored in the file and print it out using
1951 a C like syntax. If neither of these formats are found this option
1952 falls back on the @option{-W} option to print any DWARF information in
1956 @itemx --debugging-tags
1957 Like @option{-g}, but the information is generated in a format compatible
1961 @itemx --disassemble
1962 @cindex disassembling object code
1963 @cindex machine instructions
1964 Display the assembler mnemonics for the machine instructions from
1965 @var{objfile}. This option only disassembles those sections which are
1966 expected to contain instructions.
1969 @itemx --disassemble-all
1970 Like @option{-d}, but disassemble the contents of all sections, not just
1971 those expected to contain instructions.
1973 If the target is an ARM architecture this switch also has the effect
1974 of forcing the disassembler to decode pieces of data found in code
1975 sections as if they were instructions.
1977 @item --prefix-addresses
1978 When disassembling, print the complete address on each line. This is
1979 the older disassembly format.
1983 @itemx --endian=@{big|little@}
1985 @cindex disassembly endianness
1986 Specify the endianness of the object files. This only affects
1987 disassembly. This can be useful when disassembling a file format which
1988 does not describe endianness information, such as S-records.
1991 @itemx --file-headers
1992 @cindex object file header
1993 Display summary information from the overall header of
1994 each of the @var{objfile} files.
1997 @itemx --file-offsets
1998 @cindex object file offsets
1999 When disassembling sections, whenever a symbol is displayed, also
2000 display the file offset of the region of data that is about to be
2001 dumped. If zeroes are being skipped, then when disassembly resumes,
2002 tell the user how many zeroes were skipped and the file offset of the
2003 location from where the disassembly resumes. When dumping sections,
2004 display the file offset of the location from where the dump starts.
2006 @item --file-start-context
2007 @cindex source code context
2008 Specify that when displaying interlisted source code/disassembly
2009 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2010 context to the start of the file.
2013 @itemx --section-headers
2015 @cindex section headers
2016 Display summary information from the section headers of the
2019 File segments may be relocated to nonstandard addresses, for example by
2020 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2021 @command{ld}. However, some object file formats, such as a.out, do not
2022 store the starting address of the file segments. In those situations,
2023 although @command{ld} relocates the sections correctly, using @samp{objdump
2024 -h} to list the file section headers cannot show the correct addresses.
2025 Instead, it shows the usual addresses, which are implicit for the
2030 Print a summary of the options to @command{objdump} and exit.
2034 @cindex architectures available
2035 @cindex object formats available
2036 Display a list showing all architectures and object formats available
2037 for specification with @option{-b} or @option{-m}.
2040 @itemx --section=@var{name}
2041 @cindex section information
2042 Display information only for section @var{name}.
2045 @itemx --line-numbers
2046 @cindex source filenames for object files
2047 Label the display (using debugging information) with the filename and
2048 source line numbers corresponding to the object code or relocs shown.
2049 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2051 @item -m @var{machine}
2052 @itemx --architecture=@var{machine}
2053 @cindex architecture
2054 @cindex disassembly architecture
2055 Specify the architecture to use when disassembling object files. This
2056 can be useful when disassembling object files which do not describe
2057 architecture information, such as S-records. You can list the available
2058 architectures with the @option{-i} option.
2060 If the target is an ARM architecture then this switch has an
2061 additional effect. It restricts the disassembly to only those
2062 instructions supported by the architecture specified by @var{machine}.
2063 If it is necessary to use this switch because the input file does not
2064 contain any architecture information, but it is also desired to
2065 disassemble all the instructions use @option{-marm}.
2067 @item -M @var{options}
2068 @itemx --disassembler-options=@var{options}
2069 Pass target specific information to the disassembler. Only supported on
2070 some targets. If it is necessary to specify more than one
2071 disassembler option then multiple @option{-M} options can be used or
2072 can be placed together into a comma separated list.
2074 If the target is an ARM architecture then this switch can be used to
2075 select which register name set is used during disassembler. Specifying
2076 @option{-M reg-names-std} (the default) will select the register names as
2077 used in ARM's instruction set documentation, but with register 13 called
2078 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2079 @option{-M reg-names-apcs} will select the name set used by the ARM
2080 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2081 just use @samp{r} followed by the register number.
2083 There are also two variants on the APCS register naming scheme enabled
2084 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2085 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2086 with the normal register names or the special register names).
2088 This option can also be used for ARM architectures to force the
2089 disassembler to interpret all instructions as Thumb instructions by
2090 using the switch @option{--disassembler-options=force-thumb}. This can be
2091 useful when attempting to disassemble thumb code produced by other
2094 For the x86, some of the options duplicate functions of the @option{-m}
2095 switch, but allow finer grained control. Multiple selections from the
2096 following may be specified as a comma separated string.
2097 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
2098 the given architecture. @option{intel} and @option{att} select between
2099 intel syntax mode and AT&T syntax mode.
2100 @option{intel-mnemonic} and @option{att-mnemonic} select between
2101 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
2102 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
2103 @option{addr64}, @option{addr32},
2104 @option{addr16}, @option{data32} and @option{data16} specify the default
2105 address size and operand size. These four options will be overridden if
2106 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
2107 option string. Lastly, @option{suffix}, when in AT&T mode,
2108 instructs the disassembler to print a mnemonic suffix even when the
2109 suffix could be inferred by the operands.
2111 For PowerPC, @option{booke} controls the disassembly of BookE
2112 instructions. @option{32} and @option{64} select PowerPC and
2113 PowerPC64 disassembly, respectively. @option{e300} selects
2114 disassembly for the e300 family. @option{440} selects disassembly for
2115 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2116 single instructions of the PPC750CL.
2118 For MIPS, this option controls the printing of instruction mnemonic
2119 names and register names in disassembled instructions. Multiple
2120 selections from the following may be specified as a comma separated
2121 string, and invalid options are ignored:
2125 Print the 'raw' instruction mnemonic instead of some pseudo
2126 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2127 'sll' instead of 'nop', etc.
2130 Disassemble MSA instructions.
2133 Disassemble the virtualization ASE instructions.
2136 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2138 @item gpr-names=@var{ABI}
2139 Print GPR (general-purpose register) names as appropriate
2140 for the specified ABI. By default, GPR names are selected according to
2141 the ABI of the binary being disassembled.
2143 @item fpr-names=@var{ABI}
2144 Print FPR (floating-point register) names as
2145 appropriate for the specified ABI. By default, FPR numbers are printed
2148 @item cp0-names=@var{ARCH}
2149 Print CP0 (system control coprocessor; coprocessor 0) register names
2150 as appropriate for the CPU or architecture specified by
2151 @var{ARCH}. By default, CP0 register names are selected according to
2152 the architecture and CPU of the binary being disassembled.
2154 @item hwr-names=@var{ARCH}
2155 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2156 as appropriate for the CPU or architecture specified by
2157 @var{ARCH}. By default, HWR names are selected according to
2158 the architecture and CPU of the binary being disassembled.
2160 @item reg-names=@var{ABI}
2161 Print GPR and FPR names as appropriate for the selected ABI.
2163 @item reg-names=@var{ARCH}
2164 Print CPU-specific register names (CP0 register and HWR names)
2165 as appropriate for the selected CPU or architecture.
2168 For any of the options listed above, @var{ABI} or
2169 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2170 rather than names, for the selected types of registers.
2171 You can list the available values of @var{ABI} and @var{ARCH} using
2172 the @option{--help} option.
2174 For VAX, you can specify function entry addresses with @option{-M
2175 entry:0xf00ba}. You can use this multiple times to properly
2176 disassemble VAX binary files that don't contain symbol tables (like
2177 ROM dumps). In these cases, the function entry mask would otherwise
2178 be decoded as VAX instructions, which would probably lead the rest
2179 of the function being wrongly disassembled.
2182 @itemx --private-headers
2183 Print information that is specific to the object file format. The exact
2184 information printed depends upon the object file format. For some
2185 object file formats, no additional information is printed.
2187 @item -P @var{options}
2188 @itemx --private=@var{options}
2189 Print information that is specific to the object file format. The
2190 argument @var{options} is a comma separated list that depends on the
2191 format (the lists of options is displayed with the help).
2193 For XCOFF, the available options are: @option{header}, @option{aout},
2194 @option{sections}, @option{syms}, @option{relocs}, @option{lineno},
2195 @option{loader}, @option{except}, @option{typchk}, @option{traceback},
2196 @option{toc} and @option{ldinfo}.
2200 @cindex relocation entries, in object file
2201 Print the relocation entries of the file. If used with @option{-d} or
2202 @option{-D}, the relocations are printed interspersed with the
2206 @itemx --dynamic-reloc
2207 @cindex dynamic relocation entries, in object file
2208 Print the dynamic relocation entries of the file. This is only
2209 meaningful for dynamic objects, such as certain types of shared
2210 libraries. As for @option{-r}, if used with @option{-d} or
2211 @option{-D}, the relocations are printed interspersed with the
2215 @itemx --full-contents
2216 @cindex sections, full contents
2217 @cindex object file sections
2218 Display the full contents of any sections requested. By default all
2219 non-empty sections are displayed.
2223 @cindex source disassembly
2224 @cindex disassembly, with source
2225 Display source code intermixed with disassembly, if possible. Implies
2228 @item --prefix=@var{prefix}
2229 @cindex Add prefix to absolute paths
2230 Specify @var{prefix} to add to the absolute paths when used with
2233 @item --prefix-strip=@var{level}
2234 @cindex Strip absolute paths
2235 Indicate how many initial directory names to strip off the hardwired
2236 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2238 @item --show-raw-insn
2239 When disassembling instructions, print the instruction in hex as well as
2240 in symbolic form. This is the default except when
2241 @option{--prefix-addresses} is used.
2243 @item --no-show-raw-insn
2244 When disassembling instructions, do not print the instruction bytes.
2245 This is the default when @option{--prefix-addresses} is used.
2247 @item --insn-width=@var{width}
2248 @cindex Instruction width
2249 Display @var{width} bytes on a single line when disassembling
2252 @item -W[lLiaprmfFsoRt]
2253 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
2255 @cindex debug symbols
2256 Displays the contents of the debug sections in the file, if any are
2257 present. If one of the optional letters or words follows the switch
2258 then only data found in those specific sections will be dumped.
2260 Note that there is no single letter option to display the content of
2261 trace sections or .gdb_index.
2263 Note: the output from the @option{=info} option can also be affected
2264 by the options @option{--dwarf-depth}, the @option{--dwarf-start} and
2265 the @option{--dwarf-check}.
2267 @item --dwarf-depth=@var{n}
2268 Limit the dump of the @code{.debug_info} section to @var{n} children.
2269 This is only useful with @option{--dwarf=info}. The default is
2270 to print all DIEs; the special value 0 for @var{n} will also have this
2273 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2274 levels will not be printed. The range for @var{n} is zero-based.
2276 @item --dwarf-start=@var{n}
2277 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2278 useful with @option{--dwarf=info}.
2280 If specified, this option will suppress printing of any header
2281 information and all DIEs before the DIE numbered @var{n}. Only
2282 siblings and children of the specified DIE will be printed.
2284 This can be used in conjunction with @option{--dwarf-depth}.
2287 Enable additional checks for consistency of Dwarf information.
2293 @cindex debug symbols
2294 @cindex ELF object file format
2295 Display the full contents of any sections requested. Display the
2296 contents of the .stab and .stab.index and .stab.excl sections from an
2297 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2298 @code{.stab} debugging symbol-table entries are carried in an ELF
2299 section. In most other file formats, debugging symbol-table entries are
2300 interleaved with linkage symbols, and are visible in the @option{--syms}
2303 @item --start-address=@var{address}
2304 @cindex start-address
2305 Start displaying data at the specified address. This affects the output
2306 of the @option{-d}, @option{-r} and @option{-s} options.
2308 @item --stop-address=@var{address}
2309 @cindex stop-address
2310 Stop displaying data at the specified address. This affects the output
2311 of the @option{-d}, @option{-r} and @option{-s} options.
2315 @cindex symbol table entries, printing
2316 Print the symbol table entries of the file.
2317 This is similar to the information provided by the @samp{nm} program,
2318 although the display format is different. The format of the output
2319 depends upon the format of the file being dumped, but there are two main
2320 types. One looks like this:
2323 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2324 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2327 where the number inside the square brackets is the number of the entry
2328 in the symbol table, the @var{sec} number is the section number, the
2329 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2330 symbol's type, the @var{scl} number is the symbol's storage class and
2331 the @var{nx} value is the number of auxilary entries associated with
2332 the symbol. The last two fields are the symbol's value and its name.
2334 The other common output format, usually seen with ELF based files,
2338 00000000 l d .bss 00000000 .bss
2339 00000000 g .text 00000000 fred
2342 Here the first number is the symbol's value (sometimes refered to as
2343 its address). The next field is actually a set of characters and
2344 spaces indicating the flag bits that are set on the symbol. These
2345 characters are described below. Next is the section with which the
2346 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2347 not connected with any section), or @emph{*UND*} if the section is
2348 referenced in the file being dumped, but not defined there.
2350 After the section name comes another field, a number, which for common
2351 symbols is the alignment and for other symbol is the size. Finally
2352 the symbol's name is displayed.
2354 The flag characters are divided into 7 groups as follows:
2360 The symbol is a local (l), global (g), unique global (u), neither
2361 global nor local (a space) or both global and local (!). A
2362 symbol can be neither local or global for a variety of reasons, e.g.,
2363 because it is used for debugging, but it is probably an indication of
2364 a bug if it is ever both local and global. Unique global symbols are
2365 a GNU extension to the standard set of ELF symbol bindings. For such
2366 a symbol the dynamic linker will make sure that in the entire process
2367 there is just one symbol with this name and type in use.
2370 The symbol is weak (w) or strong (a space).
2373 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2376 The symbol is a warning (W) or a normal symbol (a space). A warning
2377 symbol's name is a message to be displayed if the symbol following the
2378 warning symbol is ever referenced.
2382 The symbol is an indirect reference to another symbol (I), a function
2383 to be evaluated during reloc processing (i) or a normal symbol (a
2388 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2389 normal symbol (a space).
2394 The symbol is the name of a function (F) or a file (f) or an object
2395 (O) or just a normal symbol (a space).
2399 @itemx --dynamic-syms
2400 @cindex dynamic symbol table entries, printing
2401 Print the dynamic symbol table entries of the file. This is only
2402 meaningful for dynamic objects, such as certain types of shared
2403 libraries. This is similar to the information provided by the @samp{nm}
2404 program when given the @option{-D} (@option{--dynamic}) option.
2406 @item --special-syms
2407 When displaying symbols include those which the target considers to be
2408 special in some way and which would not normally be of interest to the
2413 Print the version number of @command{objdump} and exit.
2416 @itemx --all-headers
2417 @cindex all header information, object file
2418 @cindex header information, all
2419 Display all available header information, including the symbol table and
2420 relocation entries. Using @option{-x} is equivalent to specifying all of
2421 @option{-a -f -h -p -r -t}.
2425 @cindex wide output, printing
2426 Format some lines for output devices that have more than 80 columns.
2427 Also do not truncate symbol names when they are displayed.
2430 @itemx --disassemble-zeroes
2431 Normally the disassembly output will skip blocks of zeroes. This
2432 option directs the disassembler to disassemble those blocks, just like
2439 @c man begin SEEALSO objdump
2440 nm(1), readelf(1), and the Info entries for @file{binutils}.
2448 @cindex archive contents
2449 @cindex symbol index
2451 @c man title ranlib generate index to archive.
2454 @c man begin SYNOPSIS ranlib
2455 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2459 @c man begin DESCRIPTION ranlib
2461 @command{ranlib} generates an index to the contents of an archive and
2462 stores it in the archive. The index lists each symbol defined by a
2463 member of an archive that is a relocatable object file.
2465 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2467 An archive with such an index speeds up linking to the library and
2468 allows routines in the library to call each other without regard to
2469 their placement in the archive.
2471 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2472 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2477 @c man begin OPTIONS ranlib
2483 Show usage information for @command{ranlib}.
2488 Show the version number of @command{ranlib}.
2491 @cindex deterministic archives
2492 @kindex --enable-deterministic-archives
2493 Operate in @emph{deterministic} mode. The symbol map archive member's
2494 header will show zero for the UID, GID, and timestamp. When this
2495 option is used, multiple runs will produce identical output files.
2497 If @file{binutils} was configured with
2498 @option{--enable-deterministic-archives}, then this mode is on by
2499 default. It can be disabled with the @samp{-U} option, described
2503 Update the timestamp of the symbol map of an archive.
2506 @cindex deterministic archives
2507 @kindex --enable-deterministic-archives
2508 Do @emph{not} operate in @emph{deterministic} mode. This is the
2509 inverse of the @samp{-D} option, above: the archive index will get
2510 actual UID, GID, timestamp, and file mode values.
2512 If @file{binutils} was configured @emph{without}
2513 @option{--enable-deterministic-archives}, then this mode is on by
2521 @c man begin SEEALSO ranlib
2522 ar(1), nm(1), and the Info entries for @file{binutils}.
2530 @cindex section sizes
2532 @c man title size list section sizes and total size.
2535 @c man begin SYNOPSIS size
2536 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2538 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2540 [@option{-t}|@option{--totals}]
2541 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2542 [@var{objfile}@dots{}]
2546 @c man begin DESCRIPTION size
2548 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2549 size---for each of the object or archive files @var{objfile} in its
2550 argument list. By default, one line of output is generated for each
2551 object file or each module in an archive.
2553 @var{objfile}@dots{} are the object files to be examined.
2554 If none are specified, the file @code{a.out} will be used.
2558 @c man begin OPTIONS size
2560 The command line options have the following meanings:
2565 @itemx --format=@var{compatibility}
2566 @cindex @command{size} display format
2567 Using one of these options, you can choose whether the output from @sc{gnu}
2568 @command{size} resembles output from System V @command{size} (using @option{-A},
2569 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2570 @option{--format=berkeley}). The default is the one-line format similar to
2572 @c Bonus for doc-source readers: you can also say --format=strange (or
2573 @c anything else that starts with 's') for sysv, and --format=boring (or
2574 @c anything else that starts with 'b') for Berkeley.
2576 Here is an example of the Berkeley (default) format of output from
2579 $ size --format=Berkeley ranlib size
2580 text data bss dec hex filename
2581 294880 81920 11592 388392 5ed28 ranlib
2582 294880 81920 11888 388688 5ee50 size
2586 This is the same data, but displayed closer to System V conventions:
2589 $ size --format=SysV ranlib size
2607 Show a summary of acceptable arguments and options.
2612 @itemx --radix=@var{number}
2613 @cindex @command{size} number format
2614 @cindex radix for section sizes
2615 Using one of these options, you can control whether the size of each
2616 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2617 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2618 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2619 values (8, 10, 16) are supported. The total size is always given in two
2620 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2621 octal and hexadecimal if you're using @option{-o}.
2624 Print total size of common symbols in each file. When using Berkeley
2625 format these are included in the bss size.
2629 Show totals of all objects listed (Berkeley format listing mode only).
2631 @item --target=@var{bfdname}
2632 @cindex object code format
2633 Specify that the object-code format for @var{objfile} is
2634 @var{bfdname}. This option may not be necessary; @command{size} can
2635 automatically recognize many formats.
2636 @xref{Target Selection}, for more information.
2640 Display the version number of @command{size}.
2646 @c man begin SEEALSO size
2647 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2654 @cindex listings strings
2655 @cindex printing strings
2656 @cindex strings, printing
2658 @c man title strings print the strings of printable characters in files.
2661 @c man begin SYNOPSIS strings
2662 strings [@option{-afovV}] [@option{-}@var{min-len}]
2663 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2664 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2665 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2666 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2667 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2668 [@option{-w}] [@option{--include-all-whitespace}]
2669 [@option{--help}] [@option{--version}] @var{file}@dots{}
2673 @c man begin DESCRIPTION strings
2675 For each @var{file} given, @sc{gnu} @command{strings} prints the
2676 printable character sequences that are at least 4 characters long (or
2677 the number given with the options below) and are followed by an
2678 unprintable character.
2680 Depending upon how the strings program was configured it will default
2681 to either displaying all the printable sequences that it can find in
2682 each file, or only those sequences that are in loadable, initialized
2683 data sections. If the file type in unrecognizable, or if strings is
2684 reading from stdin then it will always display all of the printable
2685 sequences that it can find.
2687 For backwards compatibility any file that occurs after a command line
2688 option of just @option{-} will also be scanned in full, regardless of
2689 the presence of any @option{-d} option.
2691 @command{strings} is mainly useful for determining the contents of
2696 @c man begin OPTIONS strings
2702 Scan the whole file, regardless of what sections it contains or
2703 whether those sections are loaded or initialized. Normally this is
2704 the default behaviour, but strings can be configured so that the
2705 @option{-d} is the default instead.
2707 The @option{-} option is position dependent and forces strings to
2708 perform full scans of any file that is mentioned after the @option{-}
2709 on the command line, even if the @option{-d} option has been
2714 Only print strings from initialized, loaded data sections in the
2715 file. This may reduce the amount of garbage in the output, but it
2716 also exposes the strings program to any security flaws that may be
2717 present in the BFD library used to scan and load sections. Strings
2718 can be configured so that this option is the default behaviour. In
2719 such cases the @option{-a} option can be used to avoid using the BFD
2720 library and instead just print all of the strings found in the file.
2723 @itemx --print-file-name
2724 Print the name of the file before each string.
2727 Print a summary of the program usage on the standard output and exit.
2729 @item -@var{min-len}
2730 @itemx -n @var{min-len}
2731 @itemx --bytes=@var{min-len}
2732 Print sequences of characters that are at least @var{min-len} characters
2733 long, instead of the default 4.
2736 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2737 act like @samp{-t d} instead. Since we can not be compatible with both
2738 ways, we simply chose one.
2740 @item -t @var{radix}
2741 @itemx --radix=@var{radix}
2742 Print the offset within the file before each string. The single
2743 character argument specifies the radix of the offset---@samp{o} for
2744 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2746 @item -e @var{encoding}
2747 @itemx --encoding=@var{encoding}
2748 Select the character encoding of the strings that are to be found.
2749 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2750 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2751 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2752 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2753 littleendian. Useful for finding wide character strings. (@samp{l}
2754 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2756 @item -T @var{bfdname}
2757 @itemx --target=@var{bfdname}
2758 @cindex object code format
2759 Specify an object code format other than your system's default format.
2760 @xref{Target Selection}, for more information.
2765 Print the program version number on the standard output and exit.
2768 @itemx --include-all-whitespace
2769 By default tab and space characters are included in the strings that
2770 are displayed, but other whitespace characters, such a newlines and
2771 carriage returns, are not. The @option{-w} option changes this so
2772 that all whitespace characters are considered to be part of a string.
2778 @c man begin SEEALSO strings
2779 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2780 and the Info entries for @file{binutils}.
2788 @cindex removing symbols
2789 @cindex discarding symbols
2790 @cindex symbols, discarding
2792 @c man title strip Discard symbols from object files.
2795 @c man begin SYNOPSIS strip
2796 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2797 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2798 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2799 [@option{-s}|@option{--strip-all}]
2800 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2801 [@option{--strip-dwo}]
2802 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2803 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2804 [@option{-w}|@option{--wildcard}]
2805 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2806 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2807 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2808 [@option{-D}|@option{--enable-deterministic-archives}]
2809 [@option{-U}|@option{--disable-deterministic-archives}]
2810 [@option{--keep-file-symbols}]
2811 [@option{--only-keep-debug}]
2812 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2813 [@option{--help}] [@option{--info}]
2814 @var{objfile}@dots{}
2818 @c man begin DESCRIPTION strip
2820 @sc{gnu} @command{strip} discards all symbols from object files
2821 @var{objfile}. The list of object files may include archives.
2822 At least one object file must be given.
2824 @command{strip} modifies the files named in its argument,
2825 rather than writing modified copies under different names.
2829 @c man begin OPTIONS strip
2832 @item -F @var{bfdname}
2833 @itemx --target=@var{bfdname}
2834 Treat the original @var{objfile} as a file with the object
2835 code format @var{bfdname}, and rewrite it in the same format.
2836 @xref{Target Selection}, for more information.
2839 Show a summary of the options to @command{strip} and exit.
2842 Display a list showing all architectures and object formats available.
2844 @item -I @var{bfdname}
2845 @itemx --input-target=@var{bfdname}
2846 Treat the original @var{objfile} as a file with the object
2847 code format @var{bfdname}.
2848 @xref{Target Selection}, for more information.
2850 @item -O @var{bfdname}
2851 @itemx --output-target=@var{bfdname}
2852 Replace @var{objfile} with a file in the output format @var{bfdname}.
2853 @xref{Target Selection}, for more information.
2855 @item -R @var{sectionname}
2856 @itemx --remove-section=@var{sectionname}
2857 Remove any section named @var{sectionname} from the output file. This
2858 option may be given more than once. Note that using this option
2859 inappropriately may make the output file unusable. The wildcard
2860 character @samp{*} may be given at the end of @var{sectionname}. If
2861 so, then any section starting with @var{sectionname} will be removed.
2870 @itemx --strip-debug
2871 Remove debugging symbols only.
2874 Remove the contents of all DWARF .dwo sections, leaving the
2875 remaining debugging sections and all symbols intact.
2876 See the description of this option in the @command{objcopy} section
2877 for more information.
2879 @item --strip-unneeded
2880 Remove all symbols that are not needed for relocation processing.
2882 @item -K @var{symbolname}
2883 @itemx --keep-symbol=@var{symbolname}
2884 When stripping symbols, keep symbol @var{symbolname} even if it would
2885 normally be stripped. This option may be given more than once.
2887 @item -N @var{symbolname}
2888 @itemx --strip-symbol=@var{symbolname}
2889 Remove symbol @var{symbolname} from the source file. This option may be
2890 given more than once, and may be combined with strip options other than
2894 Put the stripped output in @var{file}, rather than replacing the
2895 existing file. When this argument is used, only one @var{objfile}
2896 argument may be specified.
2899 @itemx --preserve-dates
2900 Preserve the access and modification dates of the file.
2903 @itemx --enable-deterministic-archives
2904 @cindex deterministic archives
2905 @kindex --enable-deterministic-archives
2906 Operate in @emph{deterministic} mode. When copying archive members
2907 and writing the archive index, use zero for UIDs, GIDs, timestamps,
2908 and use consistent file modes for all files.
2910 If @file{binutils} was configured with
2911 @option{--enable-deterministic-archives}, then this mode is on by default.
2912 It can be disabled with the @samp{-U} option, below.
2915 @itemx --disable-deterministic-archives
2916 @cindex deterministic archives
2917 @kindex --enable-deterministic-archives
2918 Do @emph{not} operate in @emph{deterministic} mode. This is the
2919 inverse of the @option{-D} option, above: when copying archive members
2920 and writing the archive index, use their actual UID, GID, timestamp,
2921 and file mode values.
2923 This is the default unless @file{binutils} was configured with
2924 @option{--enable-deterministic-archives}.
2928 Permit regular expressions in @var{symbolname}s used in other command
2929 line options. The question mark (?), asterisk (*), backslash (\) and
2930 square brackets ([]) operators can be used anywhere in the symbol
2931 name. If the first character of the symbol name is the exclamation
2932 point (!) then the sense of the switch is reversed for that symbol.
2939 would cause strip to only keep symbols that start with the letters
2940 ``fo'', but to discard the symbol ``foo''.
2943 @itemx --discard-all
2944 Remove non-global symbols.
2947 @itemx --discard-locals
2948 Remove compiler-generated local symbols.
2949 (These usually start with @samp{L} or @samp{.}.)
2951 @item --keep-file-symbols
2952 When stripping a file, perhaps with @option{--strip-debug} or
2953 @option{--strip-unneeded}, retain any symbols specifying source file names,
2954 which would otherwise get stripped.
2956 @item --only-keep-debug
2957 Strip a file, removing contents of any sections that would not be
2958 stripped by @option{--strip-debug} and leaving the debugging sections
2959 intact. In ELF files, this preserves all note sections in the output.
2961 The intention is that this option will be used in conjunction with
2962 @option{--add-gnu-debuglink} to create a two part executable. One a
2963 stripped binary which will occupy less space in RAM and in a
2964 distribution and the second a debugging information file which is only
2965 needed if debugging abilities are required. The suggested procedure
2966 to create these files is as follows:
2969 @item Link the executable as normal. Assuming that is is called
2971 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2972 create a file containing the debugging info.
2973 @item Run @code{objcopy --strip-debug foo} to create a
2974 stripped executable.
2975 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2976 to add a link to the debugging info into the stripped executable.
2979 Note---the choice of @code{.dbg} as an extension for the debug info
2980 file is arbitrary. Also the @code{--only-keep-debug} step is
2981 optional. You could instead do this:
2984 @item Link the executable as normal.
2985 @item Copy @code{foo} to @code{foo.full}
2986 @item Run @code{strip --strip-debug foo}
2987 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2990 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2991 full executable. It does not have to be a file created by the
2992 @option{--only-keep-debug} switch.
2994 Note---this switch is only intended for use on fully linked files. It
2995 does not make sense to use it on object files where the debugging
2996 information may be incomplete. Besides the gnu_debuglink feature
2997 currently only supports the presence of one filename containing
2998 debugging information, not multiple filenames on a one-per-object-file
3003 Show the version number for @command{strip}.
3007 Verbose output: list all object files modified. In the case of
3008 archives, @samp{strip -v} lists all members of the archive.
3014 @c man begin SEEALSO strip
3015 the Info entries for @file{binutils}.
3019 @node c++filt, addr2line, strip, Top
3023 @cindex demangling C++ symbols
3025 @c man title cxxfilt Demangle C++ and Java symbols.
3028 @c man begin SYNOPSIS cxxfilt
3029 c++filt [@option{-_}|@option{--strip-underscore}]
3030 [@option{-n}|@option{--no-strip-underscore}]
3031 [@option{-p}|@option{--no-params}]
3032 [@option{-t}|@option{--types}]
3033 [@option{-i}|@option{--no-verbose}]
3034 [@option{-s} @var{format}|@option{--format=}@var{format}]
3035 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3039 @c man begin DESCRIPTION cxxfilt
3042 The C++ and Java languages provide function overloading, which means
3043 that you can write many functions with the same name, providing that
3044 each function takes parameters of different types. In order to be
3045 able to distinguish these similarly named functions C++ and Java
3046 encode them into a low-level assembler name which uniquely identifies
3047 each different version. This process is known as @dfn{mangling}. The
3049 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3050 MS-DOS this program is named @command{CXXFILT}.}
3051 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3052 names into user-level names so that they can be read.
3054 Every alphanumeric word (consisting of letters, digits, underscores,
3055 dollars, or periods) seen in the input is a potential mangled name.
3056 If the name decodes into a C++ name, the C++ name replaces the
3057 low-level name in the output, otherwise the original word is output.
3058 In this way you can pass an entire assembler source file, containing
3059 mangled names, through @command{c++filt} and see the same source file
3060 containing demangled names.
3062 You can also use @command{c++filt} to decipher individual symbols by
3063 passing them on the command line:
3066 c++filt @var{symbol}
3069 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3070 names from the standard input instead. All the results are printed on
3071 the standard output. The difference between reading names from the
3072 command line versus reading names from the standard input is that
3073 command line arguments are expected to be just mangled names and no
3074 checking is performed to separate them from surrounding text. Thus
3081 will work and demangle the name to ``f()'' whereas:
3087 will not work. (Note the extra comma at the end of the mangled
3088 name which makes it invalid). This command however will work:
3091 echo _Z1fv, | c++filt -n
3094 and will display ``f(),'', i.e., the demangled name followed by a
3095 trailing comma. This behaviour is because when the names are read
3096 from the standard input it is expected that they might be part of an
3097 assembler source file where there might be extra, extraneous
3098 characters trailing after a mangled name. For example:
3101 .type _Z1fv, @@function
3106 @c man begin OPTIONS cxxfilt
3110 @itemx --strip-underscore
3111 On some systems, both the C and C++ compilers put an underscore in front
3112 of every name. For example, the C name @code{foo} gets the low-level
3113 name @code{_foo}. This option removes the initial underscore. Whether
3114 @command{c++filt} removes the underscore by default is target dependent.
3117 @itemx --no-strip-underscore
3118 Do not remove the initial underscore.
3122 When demangling the name of a function, do not display the types of
3123 the function's parameters.
3127 Attempt to demangle types as well as function names. This is disabled
3128 by default since mangled types are normally only used internally in
3129 the compiler, and they can be confused with non-mangled names. For example,
3130 a function called ``a'' treated as a mangled type name would be
3131 demangled to ``signed char''.
3135 Do not include implementation details (if any) in the demangled
3138 @item -s @var{format}
3139 @itemx --format=@var{format}
3140 @command{c++filt} can decode various methods of mangling, used by
3141 different compilers. The argument to this option selects which
3146 Automatic selection based on executable (the default method)
3148 the one used by the @sc{gnu} C++ compiler (g++)
3150 the one used by the Lucid compiler (lcc)
3152 the one specified by the C++ Annotated Reference Manual
3154 the one used by the HP compiler (aCC)
3156 the one used by the EDG compiler
3158 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3160 the one used by the @sc{gnu} Java compiler (gcj)
3162 the one used by the @sc{gnu} Ada compiler (GNAT).
3166 Print a summary of the options to @command{c++filt} and exit.
3169 Print the version number of @command{c++filt} and exit.
3175 @c man begin SEEALSO cxxfilt
3176 the Info entries for @file{binutils}.
3181 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3182 user interface are subject to change in future releases. In particular,
3183 a command-line option may be required in the future to decode a name
3184 passed as an argument on the command line; in other words,
3187 c++filt @var{symbol}
3191 may in a future release become
3194 c++filt @var{option} @var{symbol}
3202 @cindex address to file name and line number
3204 @c man title addr2line convert addresses into file names and line numbers.
3207 @c man begin SYNOPSIS addr2line
3208 addr2line [@option{-a}|@option{--addresses}]
3209 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3210 [@option{-C}|@option{--demangle}[=@var{style}]]
3211 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3212 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3213 [@option{-i}|@option{--inlines}]
3214 [@option{-p}|@option{--pretty-print}]
3215 [@option{-j}|@option{--section=}@var{name}]
3216 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3221 @c man begin DESCRIPTION addr2line
3223 @command{addr2line} translates addresses into file names and line numbers.
3224 Given an address in an executable or an offset in a section of a relocatable
3225 object, it uses the debugging information to figure out which file name and
3226 line number are associated with it.
3228 The executable or relocatable object to use is specified with the @option{-e}
3229 option. The default is the file @file{a.out}. The section in the relocatable
3230 object to use is specified with the @option{-j} option.
3232 @command{addr2line} has two modes of operation.
3234 In the first, hexadecimal addresses are specified on the command line,
3235 and @command{addr2line} displays the file name and line number for each
3238 In the second, @command{addr2line} reads hexadecimal addresses from
3239 standard input, and prints the file name and line number for each
3240 address on standard output. In this mode, @command{addr2line} may be used
3241 in a pipe to convert dynamically chosen addresses.
3243 The format of the output is @samp{FILENAME:LINENO}. By default
3244 each input address generates one line of output.
3246 Two options can generate additional lines before each
3247 @samp{FILENAME:LINENO} line (in that order).
3249 If the @option{-a} option is used then a line with the input address
3252 If the @option{-f} option is used, then a line with the
3253 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3254 containing the address.
3256 One option can generate additional lines after the
3257 @samp{FILENAME:LINENO} line.
3259 If the @option{-i} option is used and the code at the given address is
3260 present there because of inlining by the compiler then additional
3261 lines are displayed afterwards. One or two extra lines (if the
3262 @option{-f} option is used) are displayed for each inlined function.
3264 Alternatively if the @option{-p} option is used then each input
3265 address generates a single, long, output line containing the address,
3266 the function name, the file name and the line number. If the
3267 @option{-i} option has also been used then any inlined functions will
3268 be displayed in the same manner, but on separate lines, and prefixed
3269 by the text @samp{(inlined by)}.
3271 If the file name or function name can not be determined,
3272 @command{addr2line} will print two question marks in their place. If the
3273 line number can not be determined, @command{addr2line} will print 0.
3277 @c man begin OPTIONS addr2line
3279 The long and short forms of options, shown here as alternatives, are
3285 Display the address before the function name, file and line number
3286 information. The address is printed with a @samp{0x} prefix to easily
3289 @item -b @var{bfdname}
3290 @itemx --target=@var{bfdname}
3291 @cindex object code format
3292 Specify that the object-code format for the object files is
3296 @itemx --demangle[=@var{style}]
3297 @cindex demangling in objdump
3298 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3299 Besides removing any initial underscore prepended by the system, this
3300 makes C++ function names readable. Different compilers have different
3301 mangling styles. The optional demangling style argument can be used to
3302 choose an appropriate demangling style for your compiler. @xref{c++filt},
3303 for more information on demangling.
3305 @item -e @var{filename}
3306 @itemx --exe=@var{filename}
3307 Specify the name of the executable for which addresses should be
3308 translated. The default file is @file{a.out}.
3312 Display function names as well as file and line number information.
3316 Display only the base of each file name.
3320 If the address belongs to a function that was inlined, the source
3321 information for all enclosing scopes back to the first non-inlined
3322 function will also be printed. For example, if @code{main} inlines
3323 @code{callee1} which inlines @code{callee2}, and address is from
3324 @code{callee2}, the source information for @code{callee1} and @code{main}
3325 will also be printed.
3329 Read offsets relative to the specified section instead of absolute addresses.
3332 @itemx --pretty-print
3333 Make the output more human friendly: each location are printed on one line.
3334 If option @option{-i} is specified, lines for all enclosing scopes are
3335 prefixed with @samp{(inlined by)}.
3341 @c man begin SEEALSO addr2line
3342 Info entries for @file{binutils}.
3349 @command{nlmconv} converts a relocatable object file into a NetWare
3353 @command{nlmconv} currently works with @samp{i386} object
3354 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3355 object files in @sc{elf}, or @code{a.out} format@footnote{
3356 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3357 format in the Binary File Descriptor library. It has only been tested
3358 with the above formats.}.
3362 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3363 utilities, since it is only useful for NLM targets.
3366 @c man title nlmconv converts object code into an NLM.
3369 @c man begin SYNOPSIS nlmconv
3370 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3371 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3372 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3373 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3374 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3375 @var{infile} @var{outfile}
3379 @c man begin DESCRIPTION nlmconv
3381 @command{nlmconv} converts the relocatable @samp{i386} object file
3382 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3383 reading @var{headerfile} for NLM header information. For instructions
3384 on writing the NLM command file language used in header files, see the
3385 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3386 Development and Tools Overview}, which is part of the NLM Software
3387 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3388 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3391 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3394 @command{nlmconv} can perform a link step. In other words, you can list
3395 more than one object file for input if you list them in the definitions
3396 file (rather than simply specifying one input file on the command line).
3397 In this case, @command{nlmconv} calls the linker for you.
3401 @c man begin OPTIONS nlmconv
3404 @item -I @var{bfdname}
3405 @itemx --input-target=@var{bfdname}
3406 Object format of the input file. @command{nlmconv} can usually determine
3407 the format of a given file (so no default is necessary).
3408 @xref{Target Selection}, for more information.
3410 @item -O @var{bfdname}
3411 @itemx --output-target=@var{bfdname}
3412 Object format of the output file. @command{nlmconv} infers the output
3413 format based on the input format, e.g. for a @samp{i386} input file the
3414 output format is @samp{nlm32-i386}.
3415 @xref{Target Selection}, for more information.
3417 @item -T @var{headerfile}
3418 @itemx --header-file=@var{headerfile}
3419 Reads @var{headerfile} for NLM header information. For instructions on
3420 writing the NLM command file language used in header files, see@ see the
3421 @samp{linkers} section, of the @cite{NLM Development and Tools
3422 Overview}, which is part of the NLM Software Developer's Kit, available
3427 Displays (on standard error) the linker command line used by @command{nlmconv}.
3429 @item -l @var{linker}
3430 @itemx --linker=@var{linker}
3431 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3436 Prints a usage summary.
3440 Prints the version number for @command{nlmconv}.
3446 @c man begin SEEALSO nlmconv
3447 the Info entries for @file{binutils}.
3454 @command{windmc} may be used to generator Windows message resources.
3457 @emph{Warning:} @command{windmc} is not always built as part of the binary
3458 utilities, since it is only useful for Windows targets.
3461 @c man title windmc generates Windows message resources.
3464 @c man begin SYNOPSIS windmc
3465 windmc [options] input-file
3469 @c man begin DESCRIPTION windmc
3471 @command{windmc} reads message definitions from an input file (.mc) and
3472 translate them into a set of output files. The output files may be of
3477 A C header file containing the message definitions.
3480 A resource file compilable by the @command{windres} tool.
3483 One or more binary files containing the resource data for a specific
3487 A C include file that maps message id's to their symbolic name.
3490 The exact description of these different formats is available in
3491 documentation from Microsoft.
3493 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3494 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3495 Windows Message Compiler.
3499 @c man begin OPTIONS windmc
3504 Specifies that the input file specified is ASCII. This is the default
3509 Specifies that messages in the output @code{bin} files should be in ASCII
3514 Specifies that @code{bin} filenames should have to be prefixed by the
3515 basename of the source file.
3519 Sets the customer bit in all message id's.
3521 @item -C @var{codepage}
3522 @itemx --codepage_in @var{codepage}
3523 Sets the default codepage to be used to convert input file to UTF16. The
3524 default is ocdepage 1252.
3527 @itemx --decimal_values
3528 Outputs the constants in the header file in decimal. Default is using
3532 @itemx --extension @var{ext}
3533 The extension for the header file. The default is .h extension.
3535 @item -F @var{target}
3536 @itemx --target @var{target}
3537 Specify the BFD format to use for a bin file as output. This
3538 is a BFD target name; you can use the @option{--help} option to see a list
3539 of supported targets. Normally @command{windmc} will use the default
3540 format, which is the first one listed by the @option{--help} option.
3542 @ref{Target Selection}.
3546 @itemx --headerdir @var{path}
3547 The target directory of the generated header file. The default is the
3552 Displays a list of command line options and then exits.
3554 @item -m @var{characters}
3555 @itemx --maxlength @var{characters}
3556 Instructs @command{windmc} to generate a warning if the length
3557 of any message exceeds the number specified.
3560 @itemx --nullterminate
3561 Terminate message text in @code{bin} files by zero. By default they are
3562 terminated by CR/LF.
3565 @itemx --hresult_use
3566 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3567 file, using HRESULT definitions. Status codes are used if the flag is not
3570 @item -O @var{codepage}
3571 @itemx --codepage_out @var{codepage}
3572 Sets the default codepage to be used to output text files. The default
3576 @itemx --rcdir @var{path}
3577 The target directory for the generated @code{rc} script and the generated
3578 @code{bin} files that the resource compiler script includes. The default
3579 is the current directory.
3583 Specifies that the input file is UTF16.
3586 @itemx --unicode_out
3587 Specifies that messages in the output @code{bin} file should be in UTF16
3588 format. This is the default behaviour.
3592 Enable verbose mode.
3596 Prints the version number for @command{windmc}.
3599 @itemx --xdgb @var{path}
3600 The path of the @code{dbg} C include file that maps message id's to the
3601 symbolic name. No such file is generated without specifying the switch.
3607 @c man begin SEEALSO windmc
3608 the Info entries for @file{binutils}.
3615 @command{windres} may be used to manipulate Windows resources.
3618 @emph{Warning:} @command{windres} is not always built as part of the binary
3619 utilities, since it is only useful for Windows targets.
3622 @c man title windres manipulate Windows resources.
3625 @c man begin SYNOPSIS windres
3626 windres [options] [input-file] [output-file]
3630 @c man begin DESCRIPTION windres
3632 @command{windres} reads resources from an input file and copies them into
3633 an output file. Either file may be in one of three formats:
3637 A text format read by the Resource Compiler.
3640 A binary format generated by the Resource Compiler.
3643 A COFF object or executable.
3646 The exact description of these different formats is available in
3647 documentation from Microsoft.
3649 When @command{windres} converts from the @code{rc} format to the @code{res}
3650 format, it is acting like the Windows Resource Compiler. When
3651 @command{windres} converts from the @code{res} format to the @code{coff}
3652 format, it is acting like the Windows @code{CVTRES} program.
3654 When @command{windres} generates an @code{rc} file, the output is similar
3655 but not identical to the format expected for the input. When an input
3656 @code{rc} file refers to an external filename, an output @code{rc} file
3657 will instead include the file contents.
3659 If the input or output format is not specified, @command{windres} will
3660 guess based on the file name, or, for the input file, the file contents.
3661 A file with an extension of @file{.rc} will be treated as an @code{rc}
3662 file, a file with an extension of @file{.res} will be treated as a
3663 @code{res} file, and a file with an extension of @file{.o} or
3664 @file{.exe} will be treated as a @code{coff} file.
3666 If no output file is specified, @command{windres} will print the resources
3667 in @code{rc} format to standard output.
3669 The normal use is for you to write an @code{rc} file, use @command{windres}
3670 to convert it to a COFF object file, and then link the COFF file into
3671 your application. This will make the resources described in the
3672 @code{rc} file available to Windows.
3676 @c man begin OPTIONS windres
3679 @item -i @var{filename}
3680 @itemx --input @var{filename}
3681 The name of the input file. If this option is not used, then
3682 @command{windres} will use the first non-option argument as the input file
3683 name. If there are no non-option arguments, then @command{windres} will
3684 read from standard input. @command{windres} can not read a COFF file from
3687 @item -o @var{filename}
3688 @itemx --output @var{filename}
3689 The name of the output file. If this option is not used, then
3690 @command{windres} will use the first non-option argument, after any used
3691 for the input file name, as the output file name. If there is no
3692 non-option argument, then @command{windres} will write to standard output.
3693 @command{windres} can not write a COFF file to standard output. Note,
3694 for compatibility with @command{rc} the option @option{-fo} is also
3695 accepted, but its use is not recommended.
3697 @item -J @var{format}
3698 @itemx --input-format @var{format}
3699 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3700 @samp{coff}. If no input format is specified, @command{windres} will
3701 guess, as described above.
3703 @item -O @var{format}
3704 @itemx --output-format @var{format}
3705 The output format to generate. @var{format} may be @samp{res},
3706 @samp{rc}, or @samp{coff}. If no output format is specified,
3707 @command{windres} will guess, as described above.
3709 @item -F @var{target}
3710 @itemx --target @var{target}
3711 Specify the BFD format to use for a COFF file as input or output. This
3712 is a BFD target name; you can use the @option{--help} option to see a list
3713 of supported targets. Normally @command{windres} will use the default
3714 format, which is the first one listed by the @option{--help} option.
3716 @ref{Target Selection}.
3719 @item --preprocessor @var{program}
3720 When @command{windres} reads an @code{rc} file, it runs it through the C
3721 preprocessor first. This option may be used to specify the preprocessor
3722 to use, including any leading arguments. The default preprocessor
3723 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3725 @item --preprocessor-arg @var{option}
3726 When @command{windres} reads an @code{rc} file, it runs it through
3727 the C preprocessor first. This option may be used to specify additional
3728 text to be passed to preprocessor on its command line.
3729 This option can be used multiple times to add multiple options to the
3730 preprocessor command line.
3732 @item -I @var{directory}
3733 @itemx --include-dir @var{directory}
3734 Specify an include directory to use when reading an @code{rc} file.
3735 @command{windres} will pass this to the preprocessor as an @option{-I}
3736 option. @command{windres} will also search this directory when looking for
3737 files named in the @code{rc} file. If the argument passed to this command
3738 matches any of the supported @var{formats} (as described in the @option{-J}
3739 option), it will issue a deprecation warning, and behave just like the
3740 @option{-J} option. New programs should not use this behaviour. If a
3741 directory happens to match a @var{format}, simple prefix it with @samp{./}
3742 to disable the backward compatibility.
3744 @item -D @var{target}
3745 @itemx --define @var{sym}[=@var{val}]
3746 Specify a @option{-D} option to pass to the preprocessor when reading an
3749 @item -U @var{target}
3750 @itemx --undefine @var{sym}
3751 Specify a @option{-U} option to pass to the preprocessor when reading an
3755 Ignored for compatibility with rc.
3758 Enable verbose mode. This tells you what the preprocessor is if you
3762 @item --codepage @var{val}
3763 Specify the default codepage to use when reading an @code{rc} file.
3764 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3765 codepage code. The valid range is from zero up to 0xffff, but the
3766 validity of the codepage is host and configuration dependent.
3769 @item --language @var{val}
3770 Specify the default language to use when reading an @code{rc} file.
3771 @var{val} should be a hexadecimal language code. The low eight bits are
3772 the language, and the high eight bits are the sublanguage.
3774 @item --use-temp-file
3775 Use a temporary file to instead of using popen to read the output of
3776 the preprocessor. Use this option if the popen implementation is buggy
3777 on the host (eg., certain non-English language versions of Windows 95 and
3778 Windows 98 are known to have buggy popen where the output will instead
3781 @item --no-use-temp-file
3782 Use popen, not a temporary file, to read the output of the preprocessor.
3783 This is the default behaviour.
3787 Prints a usage summary.
3791 Prints the version number for @command{windres}.
3794 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3795 this will turn on parser debugging.
3801 @c man begin SEEALSO windres
3802 the Info entries for @file{binutils}.
3811 @command{dlltool} is used to create the files needed to create dynamic
3812 link libraries (DLLs) on systems which understand PE format image
3813 files such as Windows. A DLL contains an export table which contains
3814 information that the runtime loader needs to resolve references from a
3815 referencing program.
3817 The export table is generated by this program by reading in a
3818 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3819 will be in the DLL. A @file{.o} file can contain information in
3820 special @samp{.drectve} sections with export information.
3823 @emph{Note:} @command{dlltool} is not always built as part of the
3824 binary utilities, since it is only useful for those targets which
3828 @c man title dlltool Create files needed to build and use DLLs.
3831 @c man begin SYNOPSIS dlltool
3832 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3833 [@option{-b}|@option{--base-file} @var{base-file-name}]
3834 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3835 [@option{-z}|@option{--output-def} @var{def-file-name}]
3836 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3837 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3838 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3839 [@option{--exclude-symbols} @var{list}]
3840 [@option{--no-default-excludes}]
3841 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3842 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3843 [@option{-a}|@option{--add-indirect}]
3844 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3845 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3846 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3847 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3848 [@option{--use-nul-prefixed-import-tables}]
3849 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3850 [@option{-i}|@option{--interwork}]
3851 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3852 [@option{-v}|@option{--verbose}]
3853 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3854 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
3855 [object-file @dots{}]
3859 @c man begin DESCRIPTION dlltool
3861 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3862 @option{-b} options as well as object files specified on the command
3863 line. It then processes these inputs and if the @option{-e} option has
3864 been specified it creates a exports file. If the @option{-l} option
3865 has been specified it creates a library file and if the @option{-z} option
3866 has been specified it creates a def file. Any or all of the @option{-e},
3867 @option{-l} and @option{-z} options can be present in one invocation of
3870 When creating a DLL, along with the source for the DLL, it is necessary
3871 to have three other files. @command{dlltool} can help with the creation of
3874 The first file is a @file{.def} file which specifies which functions are
3875 exported from the DLL, which functions the DLL imports, and so on. This
3876 is a text file and can be created by hand, or @command{dlltool} can be used
3877 to create it using the @option{-z} option. In this case @command{dlltool}
3878 will scan the object files specified on its command line looking for
3879 those functions which have been specially marked as being exported and
3880 put entries for them in the @file{.def} file it creates.
3882 In order to mark a function as being exported from a DLL, it needs to
3883 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3884 section of the object file. This can be done in C by using the
3888 asm (".section .drectve");
3889 asm (".ascii \"-export:my_func\"");
3891 int my_func (void) @{ @dots{} @}
3894 The second file needed for DLL creation is an exports file. This file
3895 is linked with the object files that make up the body of the DLL and it
3896 handles the interface between the DLL and the outside world. This is a
3897 binary file and it can be created by giving the @option{-e} option to
3898 @command{dlltool} when it is creating or reading in a @file{.def} file.
3900 The third file needed for DLL creation is the library file that programs
3901 will link with in order to access the functions in the DLL (an `import
3902 library'). This file can be created by giving the @option{-l} option to
3903 dlltool when it is creating or reading in a @file{.def} file.
3905 If the @option{-y} option is specified, dlltool generates a delay-import
3906 library that can be used instead of the normal import library to allow
3907 a program to link to the dll only as soon as an imported function is
3908 called for the first time. The resulting executable will need to be
3909 linked to the static delayimp library containing __delayLoadHelper2(),
3910 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
3912 @command{dlltool} builds the library file by hand, but it builds the
3913 exports file by creating temporary files containing assembler statements
3914 and then assembling these. The @option{-S} command line option can be
3915 used to specify the path to the assembler that dlltool will use,
3916 and the @option{-f} option can be used to pass specific flags to that
3917 assembler. The @option{-n} can be used to prevent dlltool from deleting
3918 these temporary assembler files when it is done, and if @option{-n} is
3919 specified twice then this will prevent dlltool from deleting the
3920 temporary object files it used to build the library.
3922 Here is an example of creating a DLL from a source file @samp{dll.c} and
3923 also creating a program (from an object file called @samp{program.o})
3928 dlltool -e exports.o -l dll.lib dll.o
3929 gcc dll.o exports.o -o dll.dll
3930 gcc program.o dll.lib -o program
3934 @command{dlltool} may also be used to query an existing import library
3935 to determine the name of the DLL to which it is associated. See the
3936 description of the @option{-I} or @option{--identify} option.
3940 @c man begin OPTIONS dlltool
3942 The command line options have the following meanings:
3946 @item -d @var{filename}
3947 @itemx --input-def @var{filename}
3948 @cindex input .def file
3949 Specifies the name of a @file{.def} file to be read in and processed.
3951 @item -b @var{filename}
3952 @itemx --base-file @var{filename}
3954 Specifies the name of a base file to be read in and processed. The
3955 contents of this file will be added to the relocation section in the
3956 exports file generated by dlltool.
3958 @item -e @var{filename}
3959 @itemx --output-exp @var{filename}
3960 Specifies the name of the export file to be created by dlltool.
3962 @item -z @var{filename}
3963 @itemx --output-def @var{filename}
3964 Specifies the name of the @file{.def} file to be created by dlltool.
3966 @item -l @var{filename}
3967 @itemx --output-lib @var{filename}
3968 Specifies the name of the library file to be created by dlltool.
3970 @item -y @var{filename}
3971 @itemx --output-delaylib @var{filename}
3972 Specifies the name of the delay-import library file to be created by dlltool.
3974 @item --export-all-symbols
3975 Treat all global and weak defined symbols found in the input object
3976 files as symbols to be exported. There is a small list of symbols which
3977 are not exported by default; see the @option{--no-default-excludes}
3978 option. You may add to the list of symbols to not export by using the
3979 @option{--exclude-symbols} option.
3981 @item --no-export-all-symbols
3982 Only export symbols explicitly listed in an input @file{.def} file or in
3983 @samp{.drectve} sections in the input object files. This is the default
3984 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3985 attributes in the source code.
3987 @item --exclude-symbols @var{list}
3988 Do not export the symbols in @var{list}. This is a list of symbol names
3989 separated by comma or colon characters. The symbol names should not
3990 contain a leading underscore. This is only meaningful when
3991 @option{--export-all-symbols} is used.
3993 @item --no-default-excludes
3994 When @option{--export-all-symbols} is used, it will by default avoid
3995 exporting certain special symbols. The current list of symbols to avoid
3996 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3997 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3998 to go ahead and export these special symbols. This is only meaningful
3999 when @option{--export-all-symbols} is used.
4002 @itemx --as @var{path}
4003 Specifies the path, including the filename, of the assembler to be used
4004 to create the exports file.
4006 @item -f @var{options}
4007 @itemx --as-flags @var{options}
4008 Specifies any specific command line options to be passed to the
4009 assembler when building the exports file. This option will work even if
4010 the @option{-S} option is not used. This option only takes one argument,
4011 and if it occurs more than once on the command line, then later
4012 occurrences will override earlier occurrences. So if it is necessary to
4013 pass multiple options to the assembler they should be enclosed in
4017 @itemx --dll-name @var{name}
4018 Specifies the name to be stored in the @file{.def} file as the name of
4019 the DLL when the @option{-e} option is used. If this option is not
4020 present, then the filename given to the @option{-e} option will be
4021 used as the name of the DLL.
4023 @item -m @var{machine}
4024 @itemx -machine @var{machine}
4025 Specifies the type of machine for which the library file should be
4026 built. @command{dlltool} has a built in default type, depending upon how
4027 it was created, but this option can be used to override that. This is
4028 normally only useful when creating DLLs for an ARM processor, when the
4029 contents of the DLL are actually encode using Thumb instructions.
4032 @itemx --add-indirect
4033 Specifies that when @command{dlltool} is creating the exports file it
4034 should add a section which allows the exported functions to be
4035 referenced without using the import library. Whatever the hell that
4039 @itemx --add-underscore
4040 Specifies that when @command{dlltool} is creating the exports file it
4041 should prepend an underscore to the names of @emph{all} exported symbols.
4043 @item --no-leading-underscore
4044 @item --leading-underscore
4045 Specifies whether standard symbol should be forced to be prefixed, or
4048 @item --add-stdcall-underscore
4049 Specifies that when @command{dlltool} is creating the exports file it
4050 should prepend an underscore to the names of exported @emph{stdcall}
4051 functions. Variable names and non-stdcall function names are not modified.
4052 This option is useful when creating GNU-compatible import libs for third
4053 party DLLs that were built with MS-Windows tools.
4057 Specifies that when @command{dlltool} is creating the exports file it
4058 should not append the string @samp{@@ <number>}. These numbers are
4059 called ordinal numbers and they represent another way of accessing the
4060 function in a DLL, other than by name.
4063 @itemx --add-stdcall-alias
4064 Specifies that when @command{dlltool} is creating the exports file it
4065 should add aliases for stdcall symbols without @samp{@@ <number>}
4066 in addition to the symbols with @samp{@@ <number>}.
4069 @itemx --ext-prefix-alias @var{prefix}
4070 Causes @command{dlltool} to create external aliases for all DLL
4071 imports with the specified prefix. The aliases are created for both
4072 external and import symbols with no leading underscore.
4076 Specifies that when @command{dlltool} is creating the exports and library
4077 files it should omit the @code{.idata4} section. This is for compatibility
4078 with certain operating systems.
4080 @item --use-nul-prefixed-import-tables
4081 Specifies that when @command{dlltool} is creating the exports and library
4082 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4083 element. This emulates old gnu import library generation of
4084 @code{dlltool}. By default this option is turned off.
4088 Specifies that when @command{dlltool} is creating the exports and library
4089 files it should omit the @code{.idata5} section. This is for compatibility
4090 with certain operating systems.
4092 @item -I @var{filename}
4093 @itemx --identify @var{filename}
4094 Specifies that @command{dlltool} should inspect the import library
4095 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4096 of the associated DLL(s). This can be performed in addition to any
4097 other operations indicated by the other options and arguments.
4098 @command{dlltool} fails if the import library does not exist or is not
4099 actually an import library. See also @option{--identify-strict}.
4101 @item --identify-strict
4102 Modifies the behavior of the @option{--identify} option, such
4103 that an error is reported if @var{filename} is associated with
4108 Specifies that @command{dlltool} should mark the objects in the library
4109 file and exports file that it produces as supporting interworking
4110 between ARM and Thumb code.
4114 Makes @command{dlltool} preserve the temporary assembler files it used to
4115 create the exports file. If this option is repeated then dlltool will
4116 also preserve the temporary object files it uses to create the library
4119 @item -t @var{prefix}
4120 @itemx --temp-prefix @var{prefix}
4121 Makes @command{dlltool} use @var{prefix} when constructing the names of
4122 temporary assembler and object files. By default, the temp file prefix
4123 is generated from the pid.
4127 Make dlltool describe what it is doing.
4131 Displays a list of command line options and then exits.
4135 Displays dlltool's version number and then exits.
4142 * def file format:: The format of the dlltool @file{.def} file
4145 @node def file format
4146 @section The format of the @command{dlltool} @file{.def} file
4148 A @file{.def} file contains any number of the following commands:
4152 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4153 The result is going to be named @var{name}@code{.exe}.
4155 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4156 The result is going to be named @var{name}@code{.dll}.
4157 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4158 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4161 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4162 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4163 Declares @var{name1} as an exported symbol from the DLL, with optional
4164 ordinal number @var{integer}, or declares @var{name1} as an alias
4165 (forward) of the function @var{external-name} in the DLL.
4166 If @var{its_name} is specified, this name is used as string in export table.
4168 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4169 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4170 If you want to use LIBRARY as name then you need to quote it.
4172 @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{]} *}
4173 Declares that @var{external-name} or the exported function whose
4174 ordinal number is @var{integer} is to be imported from the file
4175 @var{module-name}. If @var{internal-name} is specified then this is
4176 the name that the imported function will be referred to in the body of
4178 If @var{its_name} is specified, this name is used as string in import table.
4179 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4180 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4181 If you want to use LIBRARY as name then you need to quote it.
4183 @item @code{DESCRIPTION} @var{string}
4184 Puts @var{string} into the output @file{.exp} file in the
4185 @code{.rdata} section.
4187 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4188 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4189 Generates @code{--stack} or @code{--heap}
4190 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4191 section. The linker will see this and act upon it.
4193 @item @code{CODE} @var{attr} @code{+}
4194 @item @code{DATA} @var{attr} @code{+}
4195 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4196 Generates @code{--attr} @var{section-name} @var{attr} in the output
4197 @code{.drectve} section, where @var{attr} is one of @code{READ},
4198 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4199 this and act upon it.
4204 @c man begin SEEALSO dlltool
4205 The Info pages for @file{binutils}.
4212 @cindex ELF file information
4215 @c man title readelf Displays information about ELF files.
4218 @c man begin SYNOPSIS readelf
4219 readelf [@option{-a}|@option{--all}]
4220 [@option{-h}|@option{--file-header}]
4221 [@option{-l}|@option{--program-headers}|@option{--segments}]
4222 [@option{-S}|@option{--section-headers}|@option{--sections}]
4223 [@option{-g}|@option{--section-groups}]
4224 [@option{-t}|@option{--section-details}]
4225 [@option{-e}|@option{--headers}]
4226 [@option{-s}|@option{--syms}|@option{--symbols}]
4227 [@option{--dyn-syms}]
4228 [@option{-n}|@option{--notes}]
4229 [@option{-r}|@option{--relocs}]
4230 [@option{-u}|@option{--unwind}]
4231 [@option{-d}|@option{--dynamic}]
4232 [@option{-V}|@option{--version-info}]
4233 [@option{-A}|@option{--arch-specific}]
4234 [@option{-D}|@option{--use-dynamic}]
4235 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4236 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4237 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4238 [@option{-c}|@option{--archive-index}]
4239 [@option{-w[lLiaprmfFsoRt]}|
4240 @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]]
4241 [@option{--dwarf-depth=@var{n}}]
4242 [@option{--dwarf-start=@var{n}}]
4243 [@option{-I}|@option{--histogram}]
4244 [@option{-v}|@option{--version}]
4245 [@option{-W}|@option{--wide}]
4246 [@option{-H}|@option{--help}]
4247 @var{elffile}@dots{}
4251 @c man begin DESCRIPTION readelf
4253 @command{readelf} displays information about one or more ELF format object
4254 files. The options control what particular information to display.
4256 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4257 64-bit ELF files are supported, as are archives containing ELF files.
4259 This program performs a similar function to @command{objdump} but it
4260 goes into more detail and it exists independently of the @sc{bfd}
4261 library, so if there is a bug in @sc{bfd} then readelf will not be
4266 @c man begin OPTIONS readelf
4268 The long and short forms of options, shown here as alternatives, are
4269 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4275 Equivalent to specifying @option{--file-header},
4276 @option{--program-headers}, @option{--sections}, @option{--symbols},
4277 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4278 @option{--version-info}.
4281 @itemx --file-header
4282 @cindex ELF file header information
4283 Displays the information contained in the ELF header at the start of the
4287 @itemx --program-headers
4289 @cindex ELF program header information
4290 @cindex ELF segment information
4291 Displays the information contained in the file's segment headers, if it
4296 @itemx --section-headers
4297 @cindex ELF section information
4298 Displays the information contained in the file's section headers, if it
4302 @itemx --section-groups
4303 @cindex ELF section group information
4304 Displays the information contained in the file's section groups, if it
4308 @itemx --section-details
4309 @cindex ELF section information
4310 Displays the detailed section information. Implies @option{-S}.
4315 @cindex ELF symbol table information
4316 Displays the entries in symbol table section of the file, if it has one.
4319 @cindex ELF dynamic symbol table information
4320 Displays the entries in dynamic symbol table section of the file, if it
4325 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4330 Displays the contents of the NOTE segments and/or sections, if any.
4334 @cindex ELF reloc information
4335 Displays the contents of the file's relocation section, if it has one.
4339 @cindex unwind information
4340 Displays the contents of the file's unwind section, if it has one. Only
4341 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4342 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4346 @cindex ELF dynamic section information
4347 Displays the contents of the file's dynamic section, if it has one.
4350 @itemx --version-info
4351 @cindex ELF version sections information
4352 Displays the contents of the version sections in the file, it they
4356 @itemx --arch-specific
4357 Displays architecture-specific information in the file, if there
4361 @itemx --use-dynamic
4362 When displaying symbols, this option makes @command{readelf} use the
4363 symbol hash tables in the file's dynamic section, rather than the
4364 symbol table sections.
4366 @item -x <number or name>
4367 @itemx --hex-dump=<number or name>
4368 Displays the contents of the indicated section as a hexadecimal bytes.
4369 A number identifies a particular section by index in the section table;
4370 any other string identifies all sections with that name in the object file.
4372 @item -R <number or name>
4373 @itemx --relocated-dump=<number or name>
4374 Displays the contents of the indicated section as a hexadecimal
4375 bytes. A number identifies a particular section by index in the
4376 section table; any other string identifies all sections with that name
4377 in the object file. The contents of the section will be relocated
4378 before they are displayed.
4380 @item -p <number or name>
4381 @itemx --string-dump=<number or name>
4382 Displays the contents of the indicated section as printable strings.
4383 A number identifies a particular section by index in the section table;
4384 any other string identifies all sections with that name in the object file.
4387 @itemx --archive-index
4388 @cindex Archive file symbol index information
4389 Displays the file symbol index information contained in the header part
4390 of binary archives. Performs the same function as the @option{t}
4391 command to @command{ar}, but without using the BFD library. @xref{ar}.
4393 @item -w[lLiaprmfFsoRt]
4394 @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]
4395 Displays the contents of the debug sections in the file, if any are
4396 present. If one of the optional letters or words follows the switch
4397 then only data found in those specific sections will be dumped.
4399 Note that there is no single letter option to display the content of
4400 trace sections or .gdb_index.
4402 Note: the @option{=decodedline} option will display the interpreted
4403 contents of a .debug_line section whereas the @option{=rawline} option
4404 dumps the contents in a raw format.
4406 Note: the @option{=frames-interp} option will display the interpreted
4407 contents of a .debug_frame section whereas the @option{=frames} option
4408 dumps the contents in a raw format.
4410 Note: the output from the @option{=info} option can also be affected
4411 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4413 @item --dwarf-depth=@var{n}
4414 Limit the dump of the @code{.debug_info} section to @var{n} children.
4415 This is only useful with @option{--debug-dump=info}. The default is
4416 to print all DIEs; the special value 0 for @var{n} will also have this
4419 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4420 levels will not be printed. The range for @var{n} is zero-based.
4422 @item --dwarf-start=@var{n}
4423 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4424 useful with @option{--debug-dump=info}.
4426 If specified, this option will suppress printing of any header
4427 information and all DIEs before the DIE numbered @var{n}. Only
4428 siblings and children of the specified DIE will be printed.
4430 This can be used in conjunction with @option{--dwarf-depth}.
4434 Display a histogram of bucket list lengths when displaying the contents
4435 of the symbol tables.
4439 Display the version number of readelf.
4443 Don't break output lines to fit into 80 columns. By default
4444 @command{readelf} breaks section header and segment listing lines for
4445 64-bit ELF files, so that they fit into 80 columns. This option causes
4446 @command{readelf} to print each section header resp. each segment one a
4447 single line, which is far more readable on terminals wider than 80 columns.
4451 Display the command line options understood by @command{readelf}.
4458 @c man begin SEEALSO readelf
4459 objdump(1), and the Info entries for @file{binutils}.
4466 @cindex Update ELF header
4469 @c man title elfedit Update the ELF header of ELF files.
4472 @c man begin SYNOPSIS elfedit
4473 elfedit [@option{--input-mach=}@var{machine}]
4474 [@option{--input-type=}@var{type}]
4475 [@option{--input-osabi=}@var{osabi}]
4476 @option{--output-mach=}@var{machine}
4477 @option{--output-type=}@var{type}
4478 @option{--output-osabi=}@var{osabi}
4479 [@option{-v}|@option{--version}]
4480 [@option{-h}|@option{--help}]
4481 @var{elffile}@dots{}
4485 @c man begin DESCRIPTION elfedit
4487 @command{elfedit} updates the ELF header of ELF files which have
4488 the matching ELF machine and file types. The options control how and
4489 which fields in the ELF header should be updated.
4491 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4492 64-bit ELF files are supported, as are archives containing ELF files.
4495 @c man begin OPTIONS elfedit
4497 The long and short forms of options, shown here as alternatives, are
4498 equivalent. At least one of the @option{--output-mach},
4499 @option{--output-type} and @option{--output-osabi} options must be given.
4503 @item --input-mach=@var{machine}
4504 Set the matching input ELF machine type to @var{machine}. If
4505 @option{--input-mach} isn't specified, it will match any ELF
4508 The supported ELF machine types are, @var{L1OM}, @var{K1OM} and
4511 @item --output-mach=@var{machine}
4512 Change the ELF machine type in the ELF header to @var{machine}. The
4513 supported ELF machine types are the same as @option{--input-mach}.
4515 @item --input-type=@var{type}
4516 Set the matching input ELF file type to @var{type}. If
4517 @option{--input-type} isn't specified, it will match any ELF file types.
4519 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4521 @item --output-type=@var{type}
4522 Change the ELF file type in the ELF header to @var{type}. The
4523 supported ELF types are the same as @option{--input-type}.
4525 @item --input-osabi=@var{osabi}
4526 Set the matching input ELF file OSABI to @var{osabi}. If
4527 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4529 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4530 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4531 @var{Solaris}, @var{AIX}, @var{Irix},
4532 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4533 @var{NSK}, @var{AROS} and @var{FenixOS}.
4535 @item --output-osabi=@var{osabi}
4536 Change the ELF OSABI in the ELF header to @var{osabi}. The
4537 supported ELF OSABI are the same as @option{--input-osabi}.
4541 Display the version number of @command{elfedit}.
4545 Display the command line options understood by @command{elfedit}.
4552 @c man begin SEEALSO elfedit
4553 readelf(1), and the Info entries for @file{binutils}.
4557 @node Common Options
4558 @chapter Common Options
4560 The following command-line options are supported by all of the
4561 programs described in this manual.
4563 @c man begin OPTIONS
4565 @include at-file.texi
4569 Display the command-line options supported by the program.
4572 Display the version number of the program.
4574 @c man begin OPTIONS
4578 @node Selecting the Target System
4579 @chapter Selecting the Target System
4581 You can specify two aspects of the target system to the @sc{gnu}
4582 binary file utilities, each in several ways:
4592 In the following summaries, the lists of ways to specify values are in
4593 order of decreasing precedence. The ways listed first override those
4596 The commands to list valid values only list the values for which the
4597 programs you are running were configured. If they were configured with
4598 @option{--enable-targets=all}, the commands list most of the available
4599 values, but a few are left out; not all targets can be configured in at
4600 once because some of them can only be configured @dfn{native} (on hosts
4601 with the same type as the target system).
4604 * Target Selection::
4605 * Architecture Selection::
4608 @node Target Selection
4609 @section Target Selection
4611 A @dfn{target} is an object file format. A given target may be
4612 supported for multiple architectures (@pxref{Architecture Selection}).
4613 A target selection may also have variations for different operating
4614 systems or architectures.
4616 The command to list valid target values is @samp{objdump -i}
4617 (the first column of output contains the relevant information).
4619 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4620 @samp{a.out-sunos-big}.
4622 You can also specify a target using a configuration triplet. This is
4623 the same sort of name that is passed to @file{configure} to specify a
4624 target. When you use a configuration triplet as an argument, it must be
4625 fully canonicalized. You can see the canonical version of a triplet by
4626 running the shell script @file{config.sub} which is included with the
4629 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4630 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4632 @subheading @command{objdump} Target
4638 command line option: @option{-b} or @option{--target}
4641 environment variable @code{GNUTARGET}
4644 deduced from the input file
4647 @subheading @command{objcopy} and @command{strip} Input Target
4653 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4656 environment variable @code{GNUTARGET}
4659 deduced from the input file
4662 @subheading @command{objcopy} and @command{strip} Output Target
4668 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4671 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4674 environment variable @code{GNUTARGET}
4677 deduced from the input file
4680 @subheading @command{nm}, @command{size}, and @command{strings} Target
4686 command line option: @option{--target}
4689 environment variable @code{GNUTARGET}
4692 deduced from the input file
4695 @node Architecture Selection
4696 @section Architecture Selection
4698 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4699 to run. Its name may contain a colon, separating the name of the
4700 processor family from the name of the particular @sc{cpu}.
4702 The command to list valid architecture values is @samp{objdump -i} (the
4703 second column contains the relevant information).
4705 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4707 @subheading @command{objdump} Architecture
4713 command line option: @option{-m} or @option{--architecture}
4716 deduced from the input file
4719 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4725 deduced from the input file
4728 @node Reporting Bugs
4729 @chapter Reporting Bugs
4731 @cindex reporting bugs
4733 Your bug reports play an essential role in making the binary utilities
4736 Reporting a bug may help you by bringing a solution to your problem, or
4737 it may not. But in any case the principal function of a bug report is
4738 to help the entire community by making the next version of the binary
4739 utilities work better. Bug reports are your contribution to their
4742 In order for a bug report to serve its purpose, you must include the
4743 information that enables us to fix the bug.
4746 * Bug Criteria:: Have you found a bug?
4747 * Bug Reporting:: How to report bugs
4751 @section Have You Found a Bug?
4752 @cindex bug criteria
4754 If you are not sure whether you have found a bug, here are some guidelines:
4757 @cindex fatal signal
4760 If a binary utility gets a fatal signal, for any input whatever, that is
4761 a bug. Reliable utilities never crash.
4763 @cindex error on valid input
4765 If a binary utility produces an error message for valid input, that is a
4769 If you are an experienced user of binary utilities, your suggestions for
4770 improvement are welcome in any case.
4774 @section How to Report Bugs
4776 @cindex bugs, reporting
4778 A number of companies and individuals offer support for @sc{gnu}
4779 products. If you obtained the binary utilities from a support
4780 organization, we recommend you contact that organization first.
4782 You can find contact information for many support companies and
4783 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4787 In any event, we also recommend that you send bug reports for the binary
4788 utilities to @value{BUGURL}.
4791 The fundamental principle of reporting bugs usefully is this:
4792 @strong{report all the facts}. If you are not sure whether to state a
4793 fact or leave it out, state it!
4795 Often people omit facts because they think they know what causes the
4796 problem and assume that some details do not matter. Thus, you might
4797 assume that the name of a file you use in an example does not matter.
4798 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4799 a stray memory reference which happens to fetch from the location where
4800 that pathname is stored in memory; perhaps, if the pathname were
4801 different, the contents of that location would fool the utility into
4802 doing the right thing despite the bug. Play it safe and give a
4803 specific, complete example. That is the easiest thing for you to do,
4804 and the most helpful.
4806 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4807 it is new to us. Therefore, always write your bug reports on the assumption
4808 that the bug has not been reported previously.
4810 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4811 bell?'' This cannot help us fix a bug, so it is basically useless. We
4812 respond by asking for enough details to enable us to investigate.
4813 You might as well expedite matters by sending them to begin with.
4815 To enable us to fix the bug, you should include all these things:
4819 The version of the utility. Each utility announces it if you start it
4820 with the @option{--version} argument.
4822 Without this, we will not know whether there is any point in looking for
4823 the bug in the current version of the binary utilities.
4826 Any patches you may have applied to the source, including any patches
4827 made to the @code{BFD} library.
4830 The type of machine you are using, and the operating system name and
4834 What compiler (and its version) was used to compile the utilities---e.g.
4838 The command arguments you gave the utility to observe the bug. To
4839 guarantee you will not omit something important, list them all. A copy
4840 of the Makefile (or the output from make) is sufficient.
4842 If we were to try to guess the arguments, we would probably guess wrong
4843 and then we might not encounter the bug.
4846 A complete input file, or set of input files, that will reproduce the
4847 bug. If the utility is reading an object file or files, then it is
4848 generally most helpful to send the actual object files.
4850 If the source files were produced exclusively using @sc{gnu} programs
4851 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4852 may be OK to send the source files rather than the object files. In
4853 this case, be sure to say exactly what version of @command{gcc}, or
4854 whatever, was used to produce the object files. Also say how
4855 @command{gcc}, or whatever, was configured.
4858 A description of what behavior you observe that you believe is
4859 incorrect. For example, ``It gets a fatal signal.''
4861 Of course, if the bug is that the utility gets a fatal signal, then we
4862 will certainly notice it. But if the bug is incorrect output, we might
4863 not notice unless it is glaringly wrong. You might as well not give us
4864 a chance to make a mistake.
4866 Even if the problem you experience is a fatal signal, you should still
4867 say so explicitly. Suppose something strange is going on, such as your
4868 copy of the utility is out of sync, or you have encountered a bug in
4869 the C library on your system. (This has happened!) Your copy might
4870 crash and ours would not. If you told us to expect a crash, then when
4871 ours fails to crash, we would know that the bug was not happening for
4872 us. If you had not told us to expect a crash, then we would not be able
4873 to draw any conclusion from our observations.
4876 If you wish to suggest changes to the source, send us context diffs, as
4877 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4878 option. Always send diffs from the old file to the new file. If you
4879 wish to discuss something in the @command{ld} source, refer to it by
4880 context, not by line number.
4882 The line numbers in our development sources will not match those in your
4883 sources. Your line numbers would convey no useful information to us.
4886 Here are some things that are not necessary:
4890 A description of the envelope of the bug.
4892 Often people who encounter a bug spend a lot of time investigating
4893 which changes to the input file will make the bug go away and which
4894 changes will not affect it.
4896 This is often time consuming and not very useful, because the way we
4897 will find the bug is by running a single example under the debugger
4898 with breakpoints, not by pure deduction from a series of examples.
4899 We recommend that you save your time for something else.
4901 Of course, if you can find a simpler example to report @emph{instead}
4902 of the original one, that is a convenience for us. Errors in the
4903 output will be easier to spot, running under the debugger will take
4904 less time, and so on.
4906 However, simplification is not vital; if you do not want to do this,
4907 report the bug anyway and send us the entire test case you used.
4910 A patch for the bug.
4912 A patch for the bug does help us if it is a good one. But do not omit
4913 the necessary information, such as the test case, on the assumption that
4914 a patch is all we need. We might see problems with your patch and decide
4915 to fix the problem another way, or we might not understand it at all.
4917 Sometimes with programs as complicated as the binary utilities it is
4918 very hard to construct an example that will make the program follow a
4919 certain path through the code. If you do not send us the example, we
4920 will not be able to construct one, so we will not be able to verify that
4923 And if we cannot understand what bug you are trying to fix, or why your
4924 patch should be an improvement, we will not install it. A test case will
4925 help us to understand.
4928 A guess about what the bug is or what it depends on.
4930 Such guesses are usually wrong. Even we cannot guess right about such
4931 things without first using the debugger to find the facts.
4934 @node GNU Free Documentation License
4935 @appendix GNU Free Documentation License
4939 @node Binutils Index
4940 @unnumbered Binutils Index