1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2015 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
237 archive itself. For security reasons absolute paths and paths with a
238 @code{/../} component are not allowed.
240 @cindex compatibility, @command{ar}
241 @cindex @command{ar} compatibility
242 @sc{gnu} @command{ar} is designed to be compatible with two different
243 facilities. You can control its activity using command-line options,
244 like the different varieties of @command{ar} on Unix systems; or, if you
245 specify the single command-line option @option{-M}, you can control it
246 with a script supplied via standard input, like the MRI ``librarian''
252 * ar cmdline:: Controlling @command{ar} on the command line
253 * ar scripts:: Controlling @command{ar} with a script
258 @section Controlling @command{ar} on the Command Line
261 @c man begin SYNOPSIS ar
262 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{}]
266 @cindex Unix compatibility, @command{ar}
267 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
268 arguments to execute: one keyletter specifying the @emph{operation}
269 (optionally accompanied by other keyletters specifying
270 @emph{modifiers}), and the archive name to act on.
272 Most operations can also accept further @var{member} arguments,
273 specifying particular files to operate on.
275 @c man begin OPTIONS ar
277 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
278 flags @var{mod} in any order, within the first command-line argument.
280 If you wish, you may begin the first command-line argument with a
283 @cindex operations on archive
284 The @var{p} keyletter specifies what operation to execute; it may be
285 any of the following, but you must specify only one of them:
289 @cindex deleting from archive
290 @emph{Delete} modules from the archive. Specify the names of modules to
291 be deleted as @var{member}@dots{}; the archive is untouched if you
292 specify no files to delete.
294 If you specify the @samp{v} modifier, @command{ar} lists each module
298 @cindex moving in archive
299 Use this operation to @emph{move} members in an archive.
301 The ordering of members in an archive can make a difference in how
302 programs are linked using the library, if a symbol is defined in more
305 If no modifiers are used with @code{m}, any members you name in the
306 @var{member} arguments are moved to the @emph{end} of the archive;
307 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
308 specified place instead.
311 @cindex printing from archive
312 @emph{Print} the specified members of the archive, to the standard
313 output file. If the @samp{v} modifier is specified, show the member
314 name before copying its contents to standard output.
316 If you specify no @var{member} arguments, all the files in the archive are
320 @cindex quick append to archive
321 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
322 @var{archive}, without checking for replacement.
324 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
325 operation; new members are always placed at the end of the archive.
327 The modifier @samp{v} makes @command{ar} list each file as it is appended.
329 Since the point of this operation is speed, implementations of
330 @command{ar} have the option of not updating the archive's symbol
331 table if one exists. Too many different systems however assume that
332 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
333 rebuild the table even with a quick append.
335 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
336 synonym for @samp{r} - replacing already existing files in the
337 archive and appending new ones at the end.
340 @cindex replacement in archive
341 Insert the files @var{member}@dots{} into @var{archive} (with
342 @emph{replacement}). This operation differs from @samp{q} in that any
343 previously existing members are deleted if their names match those being
346 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
347 displays an error message, and leaves undisturbed any existing members
348 of the archive matching that name.
350 By default, new members are added at the end of the file; but you may
351 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
352 placement relative to some existing member.
354 The modifier @samp{v} used with this operation elicits a line of
355 output for each file inserted, along with one of the letters @samp{a} or
356 @samp{r} to indicate whether the file was appended (no old member
357 deleted) or replaced.
361 Add an index to the archive, or update it if it already exists. Note
362 this command is an exception to the rule that there can only be one
363 command letter, as it is possible to use it as either a command or a
364 modifier. In either case it does the same thing.
367 @cindex contents of archive
368 Display a @emph{table} listing the contents of @var{archive}, or those
369 of the files listed in @var{member}@dots{} that are present in the
370 archive. Normally only the member name is shown; if you also want to
371 see the modes (permissions), timestamp, owner, group, and size, you can
372 request that by also specifying the @samp{v} modifier.
374 If you do not specify a @var{member}, all files in the archive
377 @cindex repeated names in archive
378 @cindex name duplication in archive
379 If there is more than one file with the same name (say, @samp{fie}) in
380 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
381 first instance; to see them all, you must ask for a complete
382 listing---in our example, @samp{ar t b.a}.
383 @c WRS only; per Gumby, this is implementation-dependent, and in a more
384 @c recent case in fact works the other way.
387 @cindex extract from archive
388 @emph{Extract} members (named @var{member}) from the archive. You can
389 use the @samp{v} modifier with this operation, to request that
390 @command{ar} list each name as it extracts it.
392 If you do not specify a @var{member}, all files in the archive
395 Files cannot be extracted from a thin archive.
398 Displays the list of command line options supported by @command{ar}
402 Displays the version information of @command{ar} and then exits.
406 A number of modifiers (@var{mod}) may immediately follow the @var{p}
407 keyletter, to specify variations on an operation's behavior:
411 @cindex relative placement in archive
412 Add new files @emph{after} an existing member of the
413 archive. If you use the modifier @samp{a}, the name of an existing archive
414 member must be present as the @var{relpos} argument, before the
415 @var{archive} specification.
418 Add new files @emph{before} an existing member of the
419 archive. If you use the modifier @samp{b}, the name of an existing archive
420 member must be present as the @var{relpos} argument, before the
421 @var{archive} specification. (same as @samp{i}).
424 @cindex creating archives
425 @emph{Create} the archive. The specified @var{archive} is always
426 created if it did not exist, when you request an update. But a warning is
427 issued unless you specify in advance that you expect to create it, by
431 @cindex deterministic archives
432 @kindex --enable-deterministic-archives
433 Operate in @emph{deterministic} mode. When adding files and the archive
434 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
435 for all files. When this option is used, if @command{ar} is used with
436 identical options and identical input files, multiple runs will create
437 identical output files regardless of the input files' owners, groups,
438 file modes, or modification times.
440 If @file{binutils} was configured with
441 @option{--enable-deterministic-archives}, then this mode is on by default.
442 It can be disabled with the @samp{U} modifier, below.
445 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
446 names of any length. This will cause it to create archives which are
447 not compatible with the native @command{ar} program on some systems. If
448 this is a concern, the @samp{f} modifier may be used to truncate file
449 names when putting them in the archive.
452 Insert new files @emph{before} an existing member of the
453 archive. If you use the modifier @samp{i}, the name of an existing archive
454 member must be present as the @var{relpos} argument, before the
455 @var{archive} specification. (same as @samp{b}).
458 This modifier is accepted but not used.
459 @c whaffor ar l modifier??? presumably compat; with
460 @c what???---doc@@cygnus.com, 25jan91
463 Uses the @var{count} parameter. This is used if there are multiple
464 entries in the archive with the same name. Extract or delete instance
465 @var{count} of the given name from the archive.
468 @cindex dates in archive
469 Preserve the @emph{original} dates of members when extracting them. If
470 you do not specify this modifier, files extracted from the archive
471 are stamped with the time of extraction.
474 Use the full path name when matching names in the archive. @sc{gnu}
475 @command{ar} can not create an archive with a full path name (such archives
476 are not POSIX complaint), but other archive creators can. This option
477 will cause @sc{gnu} @command{ar} to match file names using a complete path
478 name, which can be convenient when extracting a single file from an
479 archive created by another tool.
482 @cindex writing archive index
483 Write an object-file index into the archive, or update an existing one,
484 even if no other change is made to the archive. You may use this modifier
485 flag either with any operation, or alone. Running @samp{ar s} on an
486 archive is equivalent to running @samp{ranlib} on it.
489 @cindex not writing archive index
490 Do not generate an archive symbol table. This can speed up building a
491 large library in several steps. The resulting archive can not be used
492 with the linker. In order to build a symbol table, you must omit the
493 @samp{S} modifier on the last execution of @samp{ar}, or you must run
494 @samp{ranlib} on the archive.
497 @cindex creating thin archive
498 Make the specified @var{archive} a @emph{thin} archive. If it already
499 exists and is a regular archive, the existing members must be present
500 in the same directory as @var{archive}.
503 @cindex updating an archive
504 Normally, @samp{ar r}@dots{} inserts all files
505 listed into the archive. If you would like to insert @emph{only} those
506 of the files you list that are newer than existing members of the same
507 names, use this modifier. The @samp{u} modifier is allowed only for the
508 operation @samp{r} (replace). In particular, the combination @samp{qu} is
509 not allowed, since checking the timestamps would lose any speed
510 advantage from the operation @samp{q}.
513 @cindex deterministic archives
514 @kindex --enable-deterministic-archives
515 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
516 of the @samp{D} modifier, above: added files and the archive index will
517 get their actual UID, GID, timestamp, and file mode values.
519 This is the default unless @file{binutils} was configured with
520 @option{--enable-deterministic-archives}.
523 This modifier requests the @emph{verbose} version of an operation. Many
524 operations display additional information, such as filenames processed,
525 when the modifier @samp{v} is appended.
528 This modifier shows the version number of @command{ar}.
531 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
532 compatibility with AIX. The behaviour produced by this option is the
533 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
534 @samp{-X} options; in particular, it does not support @option{-X32}
535 which is the default for AIX @command{ar}.
537 The optional command line switch @option{--plugin} @var{name} causes
538 @command{ar} to load the plugin called @var{name} which adds support
539 for more file formats. This option is only available if the toolchain
540 has been built with plugin support enabled.
542 The optional command line switch @option{--target} @var{bfdname}
543 specifies that the archive members are in an object code format
544 different from your system's default format. See
545 @xref{Target Selection}, for more information.
550 @c man begin SEEALSO ar
551 nm(1), ranlib(1), and the Info entries for @file{binutils}.
556 @section Controlling @command{ar} with a Script
559 ar -M [ <@var{script} ]
562 @cindex MRI compatibility, @command{ar}
563 @cindex scripts, @command{ar}
564 If you use the single command-line option @samp{-M} with @command{ar}, you
565 can control its operation with a rudimentary command language. This
566 form of @command{ar} operates interactively if standard input is coming
567 directly from a terminal. During interactive use, @command{ar} prompts for
568 input (the prompt is @samp{AR >}), and continues executing even after
569 errors. If you redirect standard input to a script file, no prompts are
570 issued, and @command{ar} abandons execution (with a nonzero exit code)
573 The @command{ar} command language is @emph{not} designed to be equivalent
574 to the command-line options; in fact, it provides somewhat less control
575 over archives. The only purpose of the command language is to ease the
576 transition to @sc{gnu} @command{ar} for developers who already have scripts
577 written for the MRI ``librarian'' program.
579 The syntax for the @command{ar} command language is straightforward:
582 commands are recognized in upper or lower case; for example, @code{LIST}
583 is the same as @code{list}. In the following descriptions, commands are
584 shown in upper case for clarity.
587 a single command may appear on each line; it is the first word on the
591 empty lines are allowed, and have no effect.
594 comments are allowed; text after either of the characters @samp{*}
595 or @samp{;} is ignored.
598 Whenever you use a list of names as part of the argument to an @command{ar}
599 command, you can separate the individual names with either commas or
600 blanks. Commas are shown in the explanations below, for clarity.
603 @samp{+} is used as a line continuation character; if @samp{+} appears
604 at the end of a line, the text on the following line is considered part
605 of the current command.
608 Here are the commands you can use in @command{ar} scripts, or when using
609 @command{ar} interactively. Three of them have special significance:
611 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
612 a temporary file required for most of the other commands.
614 @code{SAVE} commits the changes so far specified by the script. Prior
615 to @code{SAVE}, commands affect only the temporary copy of the current
619 @item ADDLIB @var{archive}
620 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
621 Add all the contents of @var{archive} (or, if specified, each named
622 @var{module} from @var{archive}) to the current archive.
624 Requires prior use of @code{OPEN} or @code{CREATE}.
626 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
627 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
628 @c else like "ar q..."
629 Add each named @var{member} as a module in the current archive.
631 Requires prior use of @code{OPEN} or @code{CREATE}.
634 Discard the contents of the current archive, canceling the effect of
635 any operations since the last @code{SAVE}. May be executed (with no
636 effect) even if no current archive is specified.
638 @item CREATE @var{archive}
639 Creates an archive, and makes it the current archive (required for many
640 other commands). The new archive is created with a temporary name; it
641 is not actually saved as @var{archive} until you use @code{SAVE}.
642 You can overwrite existing archives; similarly, the contents of any
643 existing file named @var{archive} will not be destroyed until @code{SAVE}.
645 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
646 Delete each listed @var{module} from the current archive; equivalent to
647 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
649 Requires prior use of @code{OPEN} or @code{CREATE}.
651 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
652 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
653 List each named @var{module} present in @var{archive}. The separate
654 command @code{VERBOSE} specifies the form of the output: when verbose
655 output is off, output is like that of @samp{ar -t @var{archive}
656 @var{module}@dots{}}. When verbose output is on, the listing is like
657 @samp{ar -tv @var{archive} @var{module}@dots{}}.
659 Output normally goes to the standard output stream; however, if you
660 specify @var{outputfile} as a final argument, @command{ar} directs the
664 Exit from @command{ar}, with a @code{0} exit code to indicate successful
665 completion. This command does not save the output file; if you have
666 changed the current archive since the last @code{SAVE} command, those
669 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
670 Extract each named @var{module} from the current archive, writing them
671 into the current directory as separate files. Equivalent to @samp{ar -x
672 @var{archive} @var{module}@dots{}}.
674 Requires prior use of @code{OPEN} or @code{CREATE}.
677 @c FIXME Tokens but no commands???
684 Display full contents of the current archive, in ``verbose'' style
685 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
686 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
687 enhancement, rather than present for MRI compatibility.)
689 Requires prior use of @code{OPEN} or @code{CREATE}.
691 @item OPEN @var{archive}
692 Opens an existing archive for use as the current archive (required for
693 many other commands). Any changes as the result of subsequent commands
694 will not actually affect @var{archive} until you next use @code{SAVE}.
696 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
697 In the current archive, replace each existing @var{module} (named in
698 the @code{REPLACE} arguments) from files in the current working directory.
699 To execute this command without errors, both the file, and the module in
700 the current archive, must exist.
702 Requires prior use of @code{OPEN} or @code{CREATE}.
705 Toggle an internal flag governing the output from @code{DIRECTORY}.
706 When the flag is on, @code{DIRECTORY} output matches output from
707 @samp{ar -tv }@dots{}.
710 Commit your changes to the current archive, and actually save it as a
711 file with the name specified in the last @code{CREATE} or @code{OPEN}
714 Requires prior use of @code{OPEN} or @code{CREATE}.
723 The @sc{gnu} linker @command{ld} is now described in a separate manual.
724 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
732 @c man title nm list symbols from object files
735 @c man begin SYNOPSIS nm
736 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
737 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
738 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
739 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
740 [@option{-l}|@option{--line-numbers}] [@option{-n}|@option{-v}|@option{--numeric-sort}]
741 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
742 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
743 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
744 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
745 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
746 [@option{--plugin} @var{name}] [@option{--size-sort}] [@option{--special-syms}]
747 [@option{--synthetic}] [@option{--target=}@var{bfdname}]
748 [@var{objfile}@dots{}]
752 @c man begin DESCRIPTION nm
753 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
754 If no object files are listed as arguments, @command{nm} assumes the file
757 For each symbol, @command{nm} shows:
761 The symbol value, in the radix selected by options (see below), or
762 hexadecimal by default.
765 The symbol type. At least the following types are used; others are, as
766 well, depending on the object file format. If lowercase, the symbol is
767 usually local; if uppercase, the symbol is global (external). There
768 are however a few lowercase symbols that are shown for special global
769 symbols (@code{u}, @code{v} and @code{w}).
771 @c Some more detail on exactly what these symbol types are used for
775 The symbol's value is absolute, and will not be changed by further
780 The symbol is in the uninitialized data section (known as BSS).
783 The symbol is common. Common symbols are uninitialized data. When
784 linking, multiple common symbols may appear with the same name. If the
785 symbol is defined anywhere, the common symbols are treated as undefined
788 For more details on common symbols, see the discussion of
789 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
794 The symbol is in the initialized data section.
798 The symbol is in an initialized data section for small objects. Some
799 object file formats permit more efficient access to small data objects,
800 such as a global int variable as opposed to a large global array.
803 For PE format files this indicates that the symbol is in a section
804 specific to the implementation of DLLs. For ELF format files this
805 indicates that the symbol is an indirect function. This is a GNU
806 extension to the standard set of ELF symbol types. It indicates a
807 symbol which if referenced by a relocation does not evaluate to its
808 address, but instead must be invoked at runtime. The runtime
809 execution will then return the value to be used in the relocation.
812 The symbol is an indirect reference to another symbol.
815 The symbol is a debugging symbol.
818 The symbols is in a stack unwind section.
822 The symbol is in a read only data section.
826 The symbol is in an uninitialized data section for small objects.
830 The symbol is in the text (code) section.
833 The symbol is undefined.
836 The symbol is a unique global symbol. This is a GNU extension to the
837 standard set of ELF symbol bindings. For such a symbol the dynamic linker
838 will make sure that in the entire process there is just one symbol with
839 this name and type in use.
843 The symbol is a weak object. When a weak defined symbol is linked with
844 a normal defined symbol, the normal defined symbol is used with no error.
845 When a weak undefined symbol is linked and the symbol is not defined,
846 the value of the weak symbol becomes zero with no error. On some
847 systems, uppercase indicates that a default value has been specified.
851 The symbol is a weak symbol that has not been specifically tagged as a
852 weak object symbol. When a weak defined symbol is linked with a normal
853 defined symbol, the normal defined symbol is used with no error.
854 When a weak undefined symbol is linked and the symbol is not defined,
855 the value of the symbol is determined in a system-specific manner without
856 error. On some systems, uppercase indicates that a default value has been
860 The symbol is a stabs symbol in an a.out object file. In this case, the
861 next values printed are the stabs other field, the stabs desc field, and
862 the stab type. Stabs symbols are used to hold debugging information.
865 The symbol type is unknown, or object file format specific.
874 @c man begin OPTIONS nm
875 The long and short forms of options, shown here as alternatives, are
881 @itemx --print-file-name
882 @cindex input file name
884 @cindex source file name
885 Precede each symbol by the name of the input file (or archive member)
886 in which it was found, rather than identifying the input file once only,
887 before all of its symbols.
891 @cindex debugging symbols
892 Display all symbols, even debugger-only symbols; normally these are not
896 @cindex @command{nm} format
897 @cindex @command{nm} compatibility
898 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
901 @itemx --demangle[=@var{style}]
902 @cindex demangling in nm
903 Decode (@dfn{demangle}) low-level symbol names into user-level names.
904 Besides removing any initial underscore prepended by the system, this
905 makes C++ function names readable. Different compilers have different
906 mangling styles. The optional demangling style argument can be used to
907 choose an appropriate demangling style for your compiler. @xref{c++filt},
908 for more information on demangling.
911 Do not demangle low-level symbol names. This is the default.
915 @cindex dynamic symbols
916 Display the dynamic symbols rather than the normal symbols. This is
917 only meaningful for dynamic objects, such as certain types of shared
920 @item -f @var{format}
921 @itemx --format=@var{format}
922 @cindex @command{nm} format
923 @cindex @command{nm} compatibility
924 Use the output format @var{format}, which can be @code{bsd},
925 @code{sysv}, or @code{posix}. The default is @code{bsd}.
926 Only the first character of @var{format} is significant; it can be
927 either upper or lower case.
931 @cindex external symbols
932 Display only external symbols.
936 Show a summary of the options to @command{nm} and exit.
939 @itemx --line-numbers
940 @cindex symbol line numbers
941 For each symbol, use debugging information to try to find a filename and
942 line number. For a defined symbol, look for the line number of the
943 address of the symbol. For an undefined symbol, look for the line
944 number of a relocation entry which refers to the symbol. If line number
945 information can be found, print it after the other symbol information.
949 @itemx --numeric-sort
950 Sort symbols numerically by their addresses, rather than alphabetically
955 @cindex sorting symbols
956 Do not bother to sort the symbols in any order; print them in the order
961 Use the POSIX.2 standard output format instead of the default format.
962 Equivalent to @samp{-f posix}.
965 @itemx --reverse-sort
966 Reverse the order of the sort (whether numeric or alphabetic); let the
971 Print both value and size of defined symbols for the @code{bsd} output style.
972 This option has no effect for object formats that do not record symbol
973 sizes, unless @samp{--size-sort} is also used in which case a
974 calculated size is displayed.
978 @cindex symbol index, listing
979 When listing symbols from archive members, include the index: a mapping
980 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
981 contain definitions for which names.
984 @itemx --radix=@var{radix}
985 Use @var{radix} as the radix for printing the symbol values. It must be
986 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
989 @itemx --undefined-only
990 @cindex external symbols
991 @cindex undefined symbols
992 Display only undefined symbols (those external to each object file).
996 Show the version number of @command{nm} and exit.
999 This option is ignored for compatibility with the AIX version of
1000 @command{nm}. It takes one parameter which must be the string
1001 @option{32_64}. The default mode of AIX @command{nm} corresponds
1002 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1004 @item --defined-only
1005 @cindex external symbols
1006 @cindex undefined symbols
1007 Display only defined symbols for each object file.
1009 @item --plugin @var{name}
1011 Load the plugin called @var{name} to add support for extra target
1012 types. This option is only available if the toolchain has been built
1013 with plugin support enabled.
1016 Sort symbols by size. The size is computed as the difference between
1017 the value of the symbol and the value of the symbol with the next higher
1018 value. If the @code{bsd} output format is used the size of the symbol
1019 is printed, rather than the value, and @samp{-S} must be used in order
1020 both size and value to be printed.
1022 @item --special-syms
1023 Display symbols which have a target-specific special meaning. These
1024 symbols are usually used by the target for some special processing and
1025 are not normally helpful when included in the normal symbol lists.
1026 For example for ARM targets this option would skip the mapping symbols
1027 used to mark transitions between ARM code, THUMB code and data.
1030 Include synthetic symbols in the output. These are special symbols
1031 created by the linker for various purposes. They are not shown by
1032 default since they are not part of the binary's original source code.
1034 @item --target=@var{bfdname}
1035 @cindex object code format
1036 Specify an object code format other than your system's default format.
1037 @xref{Target Selection}, for more information.
1044 @c man begin SEEALSO nm
1045 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1052 @c man title objcopy copy and translate object files
1055 @c man begin SYNOPSIS objcopy
1056 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1057 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1058 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1059 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1060 [@option{-S}|@option{--strip-all}]
1061 [@option{-g}|@option{--strip-debug}]
1062 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1063 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1064 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1065 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1066 [@option{--localize-hidden}]
1067 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1068 [@option{--globalize-symbol=}@var{symbolname}]
1069 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1070 [@option{-w}|@option{--wildcard}]
1071 [@option{-x}|@option{--discard-all}]
1072 [@option{-X}|@option{--discard-locals}]
1073 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1074 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1075 [@option{--interleave-width=}@var{width}]
1076 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1077 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1078 [@option{-p}|@option{--preserve-dates}]
1079 [@option{-D}|@option{--enable-deterministic-archives}]
1080 [@option{-U}|@option{--disable-deterministic-archives}]
1081 [@option{--debugging}]
1082 [@option{--gap-fill=}@var{val}]
1083 [@option{--pad-to=}@var{address}]
1084 [@option{--set-start=}@var{val}]
1085 [@option{--adjust-start=}@var{incr}]
1086 [@option{--change-addresses=}@var{incr}]
1087 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1088 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1089 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1090 [@option{--change-warnings}] [@option{--no-change-warnings}]
1091 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1092 [@option{--add-section} @var{sectionname}=@var{filename}]
1093 [@option{--dump-section} @var{sectionname}=@var{filename}]
1094 [@option{--update-section} @var{sectionname}=@var{filename}]
1095 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1096 [@option{--long-section-names} @{enable,disable,keep@}]
1097 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1098 [@option{--reverse-bytes=}@var{num}]
1099 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1100 [@option{--redefine-sym} @var{old}=@var{new}]
1101 [@option{--redefine-syms=}@var{filename}]
1103 [@option{--keep-symbols=}@var{filename}]
1104 [@option{--strip-symbols=}@var{filename}]
1105 [@option{--strip-unneeded-symbols=}@var{filename}]
1106 [@option{--keep-global-symbols=}@var{filename}]
1107 [@option{--localize-symbols=}@var{filename}]
1108 [@option{--globalize-symbols=}@var{filename}]
1109 [@option{--weaken-symbols=}@var{filename}]
1110 [@option{--alt-machine-code=}@var{index}]
1111 [@option{--prefix-symbols=}@var{string}]
1112 [@option{--prefix-sections=}@var{string}]
1113 [@option{--prefix-alloc-sections=}@var{string}]
1114 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1115 [@option{--keep-file-symbols}]
1116 [@option{--only-keep-debug}]
1117 [@option{--strip-dwo}]
1118 [@option{--extract-dwo}]
1119 [@option{--extract-symbol}]
1120 [@option{--writable-text}]
1121 [@option{--readonly-text}]
1124 [@option{--file-alignment=}@var{num}]
1125 [@option{--heap=}@var{size}]
1126 [@option{--image-base=}@var{address}]
1127 [@option{--section-alignment=}@var{num}]
1128 [@option{--stack=}@var{size}]
1129 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1130 [@option{--compress-debug-sections}]
1131 [@option{--decompress-debug-sections}]
1132 [@option{--dwarf-depth=@var{n}}]
1133 [@option{--dwarf-start=@var{n}}]
1134 [@option{-v}|@option{--verbose}]
1135 [@option{-V}|@option{--version}]
1136 [@option{--help}] [@option{--info}]
1137 @var{infile} [@var{outfile}]
1141 @c man begin DESCRIPTION objcopy
1142 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1143 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1144 read and write the object files. It can write the destination object
1145 file in a format different from that of the source object file. The
1146 exact behavior of @command{objcopy} is controlled by command-line options.
1147 Note that @command{objcopy} should be able to copy a fully linked file
1148 between any two formats. However, copying a relocatable object file
1149 between any two formats may not work as expected.
1151 @command{objcopy} creates temporary files to do its translations and
1152 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1153 translation work; it has access to all the formats described in @sc{bfd}
1154 and thus is able to recognize most formats without being told
1155 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1157 @command{objcopy} can be used to generate S-records by using an output
1158 target of @samp{srec} (e.g., use @samp{-O srec}).
1160 @command{objcopy} can be used to generate a raw binary file by using an
1161 output target of @samp{binary} (e.g., use @option{-O binary}). When
1162 @command{objcopy} generates a raw binary file, it will essentially produce
1163 a memory dump of the contents of the input object file. All symbols and
1164 relocation information will be discarded. The memory dump will start at
1165 the load address of the lowest section copied into the output file.
1167 When generating an S-record or a raw binary file, it may be helpful to
1168 use @option{-S} to remove sections containing debugging information. In
1169 some cases @option{-R} will be useful to remove sections which contain
1170 information that is not needed by the binary file.
1172 Note---@command{objcopy} is not able to change the endianness of its input
1173 files. If the input format has an endianness (some formats do not),
1174 @command{objcopy} can only copy the inputs into file formats that have the
1175 same endianness or which have no endianness (e.g., @samp{srec}).
1176 (However, see the @option{--reverse-bytes} option.)
1180 @c man begin OPTIONS objcopy
1184 @itemx @var{outfile}
1185 The input and output files, respectively.
1186 If you do not specify @var{outfile}, @command{objcopy} creates a
1187 temporary file and destructively renames the result with
1188 the name of @var{infile}.
1190 @item -I @var{bfdname}
1191 @itemx --input-target=@var{bfdname}
1192 Consider the source file's object format to be @var{bfdname}, rather than
1193 attempting to deduce it. @xref{Target Selection}, for more information.
1195 @item -O @var{bfdname}
1196 @itemx --output-target=@var{bfdname}
1197 Write the output file using the object format @var{bfdname}.
1198 @xref{Target Selection}, for more information.
1200 @item -F @var{bfdname}
1201 @itemx --target=@var{bfdname}
1202 Use @var{bfdname} as the object format for both the input and the output
1203 file; i.e., simply transfer data from source to destination with no
1204 translation. @xref{Target Selection}, for more information.
1206 @item -B @var{bfdarch}
1207 @itemx --binary-architecture=@var{bfdarch}
1208 Useful when transforming a architecture-less input file into an object file.
1209 In this case the output architecture can be set to @var{bfdarch}. This
1210 option will be ignored if the input file has a known @var{bfdarch}. You
1211 can access this binary data inside a program by referencing the special
1212 symbols that are created by the conversion process. These symbols are
1213 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1214 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1215 an object file and then access it in your code using these symbols.
1217 @item -j @var{sectionpattern}
1218 @itemx --only-section=@var{sectionpattern}
1219 Copy only the indicated sections from the input file to the output file.
1220 This option may be given more than once. Note that using this option
1221 inappropriately may make the output file unusable. Wildcard
1222 characters are accepted in @var{sectionpattern}.
1224 @item -R @var{sectionpattern}
1225 @itemx --remove-section=@var{sectionpattern}
1226 Remove any section matching @var{sectionpattern} from the output file.
1227 This option may be given more than once. Note that using this option
1228 inappropriately may make the output file unusable. Wildcard
1229 characters are accepted in @var{sectionpattern}. Using both the
1230 @option{-j} and @option{-R} options together results in undefined
1235 Do not copy relocation and symbol information from the source file.
1238 @itemx --strip-debug
1239 Do not copy debugging symbols or sections from the source file.
1241 @item --strip-unneeded
1242 Strip all symbols that are not needed for relocation processing.
1244 @item -K @var{symbolname}
1245 @itemx --keep-symbol=@var{symbolname}
1246 When stripping symbols, keep symbol @var{symbolname} even if it would
1247 normally be stripped. This option may be given more than once.
1249 @item -N @var{symbolname}
1250 @itemx --strip-symbol=@var{symbolname}
1251 Do not copy symbol @var{symbolname} from the source file. This option
1252 may be given more than once.
1254 @item --strip-unneeded-symbol=@var{symbolname}
1255 Do not copy symbol @var{symbolname} from the source file unless it is needed
1256 by a relocation. This option may be given more than once.
1258 @item -G @var{symbolname}
1259 @itemx --keep-global-symbol=@var{symbolname}
1260 Keep only symbol @var{symbolname} global. Make all other symbols local
1261 to the file, so that they are not visible externally. This option may
1262 be given more than once.
1264 @item --localize-hidden
1265 In an ELF object, mark all symbols that have hidden or internal visibility
1266 as local. This option applies on top of symbol-specific localization options
1267 such as @option{-L}.
1269 @item -L @var{symbolname}
1270 @itemx --localize-symbol=@var{symbolname}
1271 Make symbol @var{symbolname} local to the file, so that it is not
1272 visible externally. This option may be given more than once.
1274 @item -W @var{symbolname}
1275 @itemx --weaken-symbol=@var{symbolname}
1276 Make symbol @var{symbolname} weak. This option may be given more than once.
1278 @item --globalize-symbol=@var{symbolname}
1279 Give symbol @var{symbolname} global scoping so that it is visible
1280 outside of the file in which it is defined. This option may be given
1285 Permit regular expressions in @var{symbolname}s used in other command
1286 line options. The question mark (?), asterisk (*), backslash (\) and
1287 square brackets ([]) operators can be used anywhere in the symbol
1288 name. If the first character of the symbol name is the exclamation
1289 point (!) then the sense of the switch is reversed for that symbol.
1296 would cause objcopy to weaken all symbols that start with ``fo''
1297 except for the symbol ``foo''.
1300 @itemx --discard-all
1301 Do not copy non-global symbols from the source file.
1302 @c FIXME any reason to prefer "non-global" to "local" here?
1305 @itemx --discard-locals
1306 Do not copy compiler-generated local symbols.
1307 (These usually start with @samp{L} or @samp{.}.)
1310 @itemx --byte=@var{byte}
1311 If interleaving has been enabled via the @option{--interleave} option
1312 then start the range of bytes to keep at the @var{byte}th byte.
1313 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1314 @var{breadth} is the value given by the @option{--interleave} option.
1316 @item -i [@var{breadth}]
1317 @itemx --interleave[=@var{breadth}]
1318 Only copy a range out of every @var{breadth} bytes. (Header data is
1319 not affected). Select which byte in the range begins the copy with
1320 the @option{--byte} option. Select the width of the range with the
1321 @option{--interleave-width} option.
1323 This option is useful for creating files to program @sc{rom}. It is
1324 typically used with an @code{srec} output target. Note that
1325 @command{objcopy} will complain if you do not specify the
1326 @option{--byte} option as well.
1328 The default interleave breadth is 4, so with @option{--byte} set to 0,
1329 @command{objcopy} would copy the first byte out of every four bytes
1330 from the input to the output.
1332 @item --interleave-width=@var{width}
1333 When used with the @option{--interleave} option, copy @var{width}
1334 bytes at a time. The start of the range of bytes to be copied is set
1335 by the @option{--byte} option, and the extent of the range is set with
1336 the @option{--interleave} option.
1338 The default value for this option is 1. The value of @var{width} plus
1339 the @var{byte} value set by the @option{--byte} option must not exceed
1340 the interleave breadth set by the @option{--interleave} option.
1342 This option can be used to create images for two 16-bit flashes interleaved
1343 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1344 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1345 commands. If the input was '12345678' then the outputs would be
1346 '1256' and '3478' respectively.
1349 @itemx --preserve-dates
1350 Set the access and modification dates of the output file to be the same
1351 as those of the input file.
1354 @itemx --enable-deterministic-archives
1355 @cindex deterministic archives
1356 @kindex --enable-deterministic-archives
1357 Operate in @emph{deterministic} mode. When copying archive members
1358 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1359 and use consistent file modes for all files.
1361 If @file{binutils} was configured with
1362 @option{--enable-deterministic-archives}, then this mode is on by default.
1363 It can be disabled with the @samp{-U} option, below.
1366 @itemx --disable-deterministic-archives
1367 @cindex deterministic archives
1368 @kindex --enable-deterministic-archives
1369 Do @emph{not} operate in @emph{deterministic} mode. This is the
1370 inverse of the @option{-D} option, above: when copying archive members
1371 and writing the archive index, use their actual UID, GID, timestamp,
1372 and file mode values.
1374 This is the default unless @file{binutils} was configured with
1375 @option{--enable-deterministic-archives}.
1378 Convert debugging information, if possible. This is not the default
1379 because only certain debugging formats are supported, and the
1380 conversion process can be time consuming.
1382 @item --gap-fill @var{val}
1383 Fill gaps between sections with @var{val}. This operation applies to
1384 the @emph{load address} (LMA) of the sections. It is done by increasing
1385 the size of the section with the lower address, and filling in the extra
1386 space created with @var{val}.
1388 @item --pad-to @var{address}
1389 Pad the output file up to the load address @var{address}. This is
1390 done by increasing the size of the last section. The extra space is
1391 filled in with the value specified by @option{--gap-fill} (default zero).
1393 @item --set-start @var{val}
1394 Set the start address of the new file to @var{val}. Not all object file
1395 formats support setting the start address.
1397 @item --change-start @var{incr}
1398 @itemx --adjust-start @var{incr}
1399 @cindex changing start address
1400 Change the start address by adding @var{incr}. Not all object file
1401 formats support setting the start address.
1403 @item --change-addresses @var{incr}
1404 @itemx --adjust-vma @var{incr}
1405 @cindex changing object addresses
1406 Change the VMA and LMA addresses of all sections, as well as the start
1407 address, by adding @var{incr}. Some object file formats do not permit
1408 section addresses to be changed arbitrarily. Note that this does not
1409 relocate the sections; if the program expects sections to be loaded at a
1410 certain address, and this option is used to change the sections such
1411 that they are loaded at a different address, the program may fail.
1413 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1414 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1415 @cindex changing section address
1416 Set or change both the VMA address and the LMA address of any section
1417 matching @var{sectionpattern}. If @samp{=} is used, the section
1418 address is set to @var{val}. Otherwise, @var{val} is added to or
1419 subtracted from the section address. See the comments under
1420 @option{--change-addresses}, above. If @var{sectionpattern} does not
1421 match any sections in the input file, a warning will be issued, unless
1422 @option{--no-change-warnings} is used.
1424 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1425 @cindex changing section LMA
1426 Set or change the LMA address of any sections matching
1427 @var{sectionpattern}. The LMA address is the address where the
1428 section will be loaded into memory at program load time. Normally
1429 this is the same as the VMA address, which is the address of the
1430 section at program run time, but on some systems, especially those
1431 where a program is held in ROM, the two can be different. If @samp{=}
1432 is used, the section address is set to @var{val}. Otherwise,
1433 @var{val} is added to or subtracted from the section address. See the
1434 comments under @option{--change-addresses}, above. If
1435 @var{sectionpattern} does not match any sections in the input file, a
1436 warning will be issued, unless @option{--no-change-warnings} is used.
1438 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1439 @cindex changing section VMA
1440 Set or change the VMA address of any section matching
1441 @var{sectionpattern}. The VMA address is the address where the
1442 section will be located once the program has started executing.
1443 Normally this is the same as the LMA address, which is the address
1444 where the section will be loaded into memory, but on some systems,
1445 especially those where a program is held in ROM, the two can be
1446 different. If @samp{=} is used, the section address is set to
1447 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1448 section address. See the comments under @option{--change-addresses},
1449 above. If @var{sectionpattern} does not match any sections in the
1450 input file, a warning will be issued, unless
1451 @option{--no-change-warnings} is used.
1453 @item --change-warnings
1454 @itemx --adjust-warnings
1455 If @option{--change-section-address} or @option{--change-section-lma} or
1456 @option{--change-section-vma} is used, and the section pattern does not
1457 match any sections, issue a warning. This is the default.
1459 @item --no-change-warnings
1460 @itemx --no-adjust-warnings
1461 Do not issue a warning if @option{--change-section-address} or
1462 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1463 if the section pattern does not match any sections.
1465 @item --set-section-flags @var{sectionpattern}=@var{flags}
1466 Set the flags for any sections matching @var{sectionpattern}. The
1467 @var{flags} argument is a comma separated string of flag names. The
1468 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1469 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1470 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1471 for a section which does not have contents, but it is not meaningful
1472 to clear the @samp{contents} flag of a section which does have
1473 contents--just remove the section instead. Not all flags are
1474 meaningful for all object file formats.
1476 @item --add-section @var{sectionname}=@var{filename}
1477 Add a new section named @var{sectionname} while copying the file. The
1478 contents of the new section are taken from the file @var{filename}. The
1479 size of the section will be the size of the file. This option only
1480 works on file formats which can support sections with arbitrary names.
1481 Note - it may be necessary to use the @option{--set-section-flags}
1482 option to set the attributes of the newly created section.
1484 @item --dump-section @var{sectionname}=@var{filename}
1485 Place the contents of section named @var{sectionname} into the file
1486 @var{filename}, overwriting any contents that may have been there
1487 previously. This option is the inverse of @option{--add-section}.
1488 This option is similar to the @option{--only-section} option except
1489 that it does not create a formatted file, it just dumps the contents
1490 as raw binary data, without applying any relocations. The option can
1491 be specified more than once.
1493 @item --update-section @var{sectionname}=@var{filename}
1494 Replace the existing contents of a section named @var{sectionname}
1495 with the contents of file @var{filename}. The size of the section
1496 will be adjusted to the size of the file. The section flags for
1497 @var{sectionname} will be unchanged. For ELF format files the section
1498 to segment mapping will also remain unchanged, something which is not
1499 possible using @option{--remove-section} followed by
1500 @option{--add-section}. The option can be specified more than once.
1502 Note - it is possible to use @option{--rename-section} and
1503 @option{--update-section} to both update and rename a section from one
1504 command line. In this case, pass the original section name to
1505 @option{--update-section}, and the original and new section names to
1506 @option{--rename-section}.
1508 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1509 Rename a section from @var{oldname} to @var{newname}, optionally
1510 changing the section's flags to @var{flags} in the process. This has
1511 the advantage over usng a linker script to perform the rename in that
1512 the output stays as an object file and does not become a linked
1515 This option is particularly helpful when the input format is binary,
1516 since this will always create a section called .data. If for example,
1517 you wanted instead to create a section called .rodata containing binary
1518 data you could use the following command line to achieve it:
1521 objcopy -I binary -O <output_format> -B <architecture> \
1522 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1523 <input_binary_file> <output_object_file>
1526 @item --long-section-names @{enable,disable,keep@}
1527 Controls the handling of long section names when processing @code{COFF}
1528 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1529 is to preserve long section names if any are present in the input file.
1530 The @samp{enable} and @samp{disable} options forcibly enable or disable
1531 the use of long section names in the output object; when @samp{disable}
1532 is in effect, any long section names in the input object will be truncated.
1533 The @samp{enable} option will only emit long section names if any are
1534 present in the inputs; this is mostly the same as @samp{keep}, but it
1535 is left undefined whether the @samp{enable} option might force the
1536 creation of an empty string table in the output file.
1538 @item --change-leading-char
1539 Some object file formats use special characters at the start of
1540 symbols. The most common such character is underscore, which compilers
1541 often add before every symbol. This option tells @command{objcopy} to
1542 change the leading character of every symbol when it converts between
1543 object file formats. If the object file formats use the same leading
1544 character, this option has no effect. Otherwise, it will add a
1545 character, or remove a character, or change a character, as
1548 @item --remove-leading-char
1549 If the first character of a global symbol is a special symbol leading
1550 character used by the object file format, remove the character. The
1551 most common symbol leading character is underscore. This option will
1552 remove a leading underscore from all global symbols. This can be useful
1553 if you want to link together objects of different file formats with
1554 different conventions for symbol names. This is different from
1555 @option{--change-leading-char} because it always changes the symbol name
1556 when appropriate, regardless of the object file format of the output
1559 @item --reverse-bytes=@var{num}
1560 Reverse the bytes in a section with output contents. A section length must
1561 be evenly divisible by the value given in order for the swap to be able to
1562 take place. Reversing takes place before the interleaving is performed.
1564 This option is used typically in generating ROM images for problematic
1565 target systems. For example, on some target boards, the 32-bit words
1566 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1567 regardless of the CPU byte order. Depending on the programming model, the
1568 endianness of the ROM may need to be modified.
1570 Consider a simple file with a section containing the following eight
1571 bytes: @code{12345678}.
1573 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1574 output file would be ordered @code{21436587}.
1576 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1577 output file would be ordered @code{43218765}.
1579 By using @samp{--reverse-bytes=2} for the above example, followed by
1580 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1581 output file would be ordered @code{34127856}.
1583 @item --srec-len=@var{ival}
1584 Meaningful only for srec output. Set the maximum length of the Srecords
1585 being produced to @var{ival}. This length covers both address, data and
1588 @item --srec-forceS3
1589 Meaningful only for srec output. Avoid generation of S1/S2 records,
1590 creating S3-only record format.
1592 @item --redefine-sym @var{old}=@var{new}
1593 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1594 when one is trying link two things together for which you have no
1595 source, and there are name collisions.
1597 @item --redefine-syms=@var{filename}
1598 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1599 listed in the file @var{filename}. @var{filename} is simply a flat file,
1600 with one symbol pair per line. Line comments may be introduced by the hash
1601 character. This option may be given more than once.
1604 Change all global symbols in the file to be weak. This can be useful
1605 when building an object which will be linked against other objects using
1606 the @option{-R} option to the linker. This option is only effective when
1607 using an object file format which supports weak symbols.
1609 @item --keep-symbols=@var{filename}
1610 Apply @option{--keep-symbol} option to each symbol listed in the file
1611 @var{filename}. @var{filename} is simply a flat file, with one symbol
1612 name per line. Line comments may be introduced by the hash character.
1613 This option may be given more than once.
1615 @item --strip-symbols=@var{filename}
1616 Apply @option{--strip-symbol} option to each symbol listed in the file
1617 @var{filename}. @var{filename} is simply a flat file, with one symbol
1618 name per line. Line comments may be introduced by the hash character.
1619 This option may be given more than once.
1621 @item --strip-unneeded-symbols=@var{filename}
1622 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1623 the file @var{filename}. @var{filename} is simply a flat file, with one
1624 symbol name per line. Line comments may be introduced by the hash
1625 character. This option may be given more than once.
1627 @item --keep-global-symbols=@var{filename}
1628 Apply @option{--keep-global-symbol} option to each symbol listed in the
1629 file @var{filename}. @var{filename} is simply a flat file, with one
1630 symbol name per line. Line comments may be introduced by the hash
1631 character. This option may be given more than once.
1633 @item --localize-symbols=@var{filename}
1634 Apply @option{--localize-symbol} option to each symbol listed in the file
1635 @var{filename}. @var{filename} is simply a flat file, with one symbol
1636 name per line. Line comments may be introduced by the hash character.
1637 This option may be given more than once.
1639 @item --globalize-symbols=@var{filename}
1640 Apply @option{--globalize-symbol} option to each symbol listed in the file
1641 @var{filename}. @var{filename} is simply a flat file, with one symbol
1642 name per line. Line comments may be introduced by the hash character.
1643 This option may be given more than once.
1645 @item --weaken-symbols=@var{filename}
1646 Apply @option{--weaken-symbol} option to each symbol listed in the file
1647 @var{filename}. @var{filename} is simply a flat file, with one symbol
1648 name per line. Line comments may be introduced by the hash character.
1649 This option may be given more than once.
1651 @item --alt-machine-code=@var{index}
1652 If the output architecture has alternate machine codes, use the
1653 @var{index}th code instead of the default one. This is useful in case
1654 a machine is assigned an official code and the tool-chain adopts the
1655 new code, but other applications still depend on the original code
1656 being used. For ELF based architectures if the @var{index}
1657 alternative does not exist then the value is treated as an absolute
1658 number to be stored in the e_machine field of the ELF header.
1660 @item --writable-text
1661 Mark the output text as writable. This option isn't meaningful for all
1662 object file formats.
1664 @item --readonly-text
1665 Make the output text write protected. This option isn't meaningful for all
1666 object file formats.
1669 Mark the output file as demand paged. This option isn't meaningful for all
1670 object file formats.
1673 Mark the output file as impure. This option isn't meaningful for all
1674 object file formats.
1676 @item --prefix-symbols=@var{string}
1677 Prefix all symbols in the output file with @var{string}.
1679 @item --prefix-sections=@var{string}
1680 Prefix all section names in the output file with @var{string}.
1682 @item --prefix-alloc-sections=@var{string}
1683 Prefix all the names of all allocated sections in the output file with
1686 @item --add-gnu-debuglink=@var{path-to-file}
1687 Creates a .gnu_debuglink section which contains a reference to
1688 @var{path-to-file} and adds it to the output file. Note: the file at
1689 @var{path-to-file} must exist. Part of the process of adding the
1690 .gnu_debuglink section involves embedding a checksum of the contents
1691 of the debug info file into the section.
1693 If the debug info file is built in one location but it is going to be
1694 installed at a later time into a different location then do not use
1695 the path to the installed location. The @option{--add-gnu-debuglink}
1696 option will fail because the installed file does not exist yet.
1697 Instead put the debug info file in the current directory and use the
1698 @option{--add-gnu-debuglink} option without any directory components,
1702 objcopy --add-gnu-debuglink=foo.debug
1705 At debug time the debugger will attempt to look for the separate debug
1706 info file in a set of known locations. The exact set of these
1707 locations varies depending upon the distribution being used, but it
1712 @item * The same directory as the executable.
1714 @item * A sub-directory of the directory containing the executable
1717 @item * A global debug directory such as /usr/lib/debug.
1720 As long as the debug info file has been installed into one of these
1721 locations before the debugger is run everything should work
1724 @item --keep-file-symbols
1725 When stripping a file, perhaps with @option{--strip-debug} or
1726 @option{--strip-unneeded}, retain any symbols specifying source file names,
1727 which would otherwise get stripped.
1729 @item --only-keep-debug
1730 Strip a file, removing contents of any sections that would not be
1731 stripped by @option{--strip-debug} and leaving the debugging sections
1732 intact. In ELF files, this preserves all note sections in the output.
1734 The intention is that this option will be used in conjunction with
1735 @option{--add-gnu-debuglink} to create a two part executable. One a
1736 stripped binary which will occupy less space in RAM and in a
1737 distribution and the second a debugging information file which is only
1738 needed if debugging abilities are required. The suggested procedure
1739 to create these files is as follows:
1742 @item Link the executable as normal. Assuming that is is called
1744 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1745 create a file containing the debugging info.
1746 @item Run @code{objcopy --strip-debug foo} to create a
1747 stripped executable.
1748 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1749 to add a link to the debugging info into the stripped executable.
1752 Note---the choice of @code{.dbg} as an extension for the debug info
1753 file is arbitrary. Also the @code{--only-keep-debug} step is
1754 optional. You could instead do this:
1757 @item Link the executable as normal.
1758 @item Copy @code{foo} to @code{foo.full}
1759 @item Run @code{objcopy --strip-debug foo}
1760 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1763 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1764 full executable. It does not have to be a file created by the
1765 @option{--only-keep-debug} switch.
1767 Note---this switch is only intended for use on fully linked files. It
1768 does not make sense to use it on object files where the debugging
1769 information may be incomplete. Besides the gnu_debuglink feature
1770 currently only supports the presence of one filename containing
1771 debugging information, not multiple filenames on a one-per-object-file
1775 Remove the contents of all DWARF .dwo sections, leaving the
1776 remaining debugging sections and all symbols intact.
1777 This option is intended for use by the compiler as part of
1778 the @option{-gsplit-dwarf} option, which splits debug information
1779 between the .o file and a separate .dwo file. The compiler
1780 generates all debug information in the same file, then uses
1781 the @option{--extract-dwo} option to copy the .dwo sections to
1782 the .dwo file, then the @option{--strip-dwo} option to remove
1783 those sections from the original .o file.
1786 Extract the contents of all DWARF .dwo sections. See the
1787 @option{--strip-dwo} option for more information.
1789 @item --file-alignment @var{num}
1790 Specify the file alignment. Sections in the file will always begin at
1791 file offsets which are multiples of this number. This defaults to
1793 [This option is specific to PE targets.]
1795 @item --heap @var{reserve}
1796 @itemx --heap @var{reserve},@var{commit}
1797 Specify the number of bytes of memory to reserve (and optionally commit)
1798 to be used as heap for this program.
1799 [This option is specific to PE targets.]
1801 @item --image-base @var{value}
1802 Use @var{value} as the base address of your program or dll. This is
1803 the lowest memory location that will be used when your program or dll
1804 is loaded. To reduce the need to relocate and improve performance of
1805 your dlls, each should have a unique base address and not overlap any
1806 other dlls. The default is 0x400000 for executables, and 0x10000000
1808 [This option is specific to PE targets.]
1810 @item --section-alignment @var{num}
1811 Sets the section alignment. Sections in memory will always begin at
1812 addresses which are a multiple of this number. Defaults to 0x1000.
1813 [This option is specific to PE targets.]
1815 @item --stack @var{reserve}
1816 @itemx --stack @var{reserve},@var{commit}
1817 Specify the number of bytes of memory to reserve (and optionally commit)
1818 to be used as stack for this program.
1819 [This option is specific to PE targets.]
1821 @item --subsystem @var{which}
1822 @itemx --subsystem @var{which}:@var{major}
1823 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1824 Specifies the subsystem under which your program will execute. The
1825 legal values for @var{which} are @code{native}, @code{windows},
1826 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1827 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1828 the subsystem version also. Numeric values are also accepted for
1830 [This option is specific to PE targets.]
1832 @item --extract-symbol
1833 Keep the file's section flags and symbols but remove all section data.
1834 Specifically, the option:
1837 @item removes the contents of all sections;
1838 @item sets the size of every section to zero; and
1839 @item sets the file's start address to zero.
1842 This option is used to build a @file{.sym} file for a VxWorks kernel.
1843 It can also be a useful way of reducing the size of a @option{--just-symbols}
1846 @item --compress-debug-sections
1847 Compress DWARF debug sections using zlib. The debug sections are
1848 renamed to begin with @samp{.zdebug} instead of @samp{.debug}. Note -
1849 if compression would actually make a section @emph{larger} then it is
1850 not compressed or renamed.
1852 @item --compress-debug-sections=none
1853 @itemx --compress-debug-sections=zlib
1854 @itemx --compress-debug-sections=zlib-gnu
1855 @itemx --compress-debug-sections=zlib-gabi
1856 For ELF files, these options control how DWARF debug sections are
1857 compressed. @option{--compress-debug-sections=none} is equivalent
1858 to @option{--nocompress-debug-sections}.
1859 @option{--compress-debug-sections=zlib} and
1860 @option{--compress-debug-sections=zlib-gnu} are equivalent to
1861 @option{--compress-debug-sections}.
1862 @option{--compress-debug-sections=zlib-gabi} compresses
1863 DWARF debug sections with SHF_COMPRESSED from the ELF ABI.
1865 @item --decompress-debug-sections
1866 Decompress DWARF debug sections using zlib. The original section
1867 names of the compressed sections are restored.
1871 Show the version number of @command{objcopy}.
1875 Verbose output: list all object files modified. In the case of
1876 archives, @samp{objcopy -V} lists all members of the archive.
1879 Show a summary of the options to @command{objcopy}.
1882 Display a list showing all architectures and object formats available.
1888 @c man begin SEEALSO objcopy
1889 ld(1), objdump(1), and the Info entries for @file{binutils}.
1896 @cindex object file information
1899 @c man title objdump display information from object files.
1902 @c man begin SYNOPSIS objdump
1903 objdump [@option{-a}|@option{--archive-headers}]
1904 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1905 [@option{-C}|@option{--demangle}[=@var{style}] ]
1906 [@option{-d}|@option{--disassemble}]
1907 [@option{-D}|@option{--disassemble-all}]
1908 [@option{-z}|@option{--disassemble-zeroes}]
1909 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1910 [@option{-f}|@option{--file-headers}]
1911 [@option{-F}|@option{--file-offsets}]
1912 [@option{--file-start-context}]
1913 [@option{-g}|@option{--debugging}]
1914 [@option{-e}|@option{--debugging-tags}]
1915 [@option{-h}|@option{--section-headers}|@option{--headers}]
1916 [@option{-i}|@option{--info}]
1917 [@option{-j} @var{section}|@option{--section=}@var{section}]
1918 [@option{-l}|@option{--line-numbers}]
1919 [@option{-S}|@option{--source}]
1920 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1921 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1922 [@option{-p}|@option{--private-headers}]
1923 [@option{-P} @var{options}|@option{--private=}@var{options}]
1924 [@option{-r}|@option{--reloc}]
1925 [@option{-R}|@option{--dynamic-reloc}]
1926 [@option{-s}|@option{--full-contents}]
1927 [@option{-W[lLiaprmfFsoRt]}|
1928 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames]
1929 [=aranges,=macro,=frames,=frames-interp,=str,=loc]
1930 [=Ranges,=pubtypes,=trace_info,=trace_abbrev]
1931 [=trace_aranges,=gdb_index]
1932 [@option{-G}|@option{--stabs}]
1933 [@option{-t}|@option{--syms}]
1934 [@option{-T}|@option{--dynamic-syms}]
1935 [@option{-x}|@option{--all-headers}]
1936 [@option{-w}|@option{--wide}]
1937 [@option{--start-address=}@var{address}]
1938 [@option{--stop-address=}@var{address}]
1939 [@option{--prefix-addresses}]
1940 [@option{--[no-]show-raw-insn}]
1941 [@option{--adjust-vma=}@var{offset}]
1942 [@option{--special-syms}]
1943 [@option{--prefix=}@var{prefix}]
1944 [@option{--prefix-strip=}@var{level}]
1945 [@option{--insn-width=}@var{width}]
1946 [@option{-V}|@option{--version}]
1947 [@option{-H}|@option{--help}]
1948 @var{objfile}@dots{}
1952 @c man begin DESCRIPTION objdump
1954 @command{objdump} displays information about one or more object files.
1955 The options control what particular information to display. This
1956 information is mostly useful to programmers who are working on the
1957 compilation tools, as opposed to programmers who just want their
1958 program to compile and work.
1960 @var{objfile}@dots{} are the object files to be examined. When you
1961 specify archives, @command{objdump} shows information on each of the member
1966 @c man begin OPTIONS objdump
1968 The long and short forms of options, shown here as alternatives, are
1969 equivalent. At least one option from the list
1970 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1974 @itemx --archive-header
1975 @cindex archive headers
1976 If any of the @var{objfile} files are archives, display the archive
1977 header information (in a format similar to @samp{ls -l}). Besides the
1978 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1979 the object file format of each archive member.
1981 @item --adjust-vma=@var{offset}
1982 @cindex section addresses in objdump
1983 @cindex VMA in objdump
1984 When dumping information, first add @var{offset} to all the section
1985 addresses. This is useful if the section addresses do not correspond to
1986 the symbol table, which can happen when putting sections at particular
1987 addresses when using a format which can not represent section addresses,
1990 @item -b @var{bfdname}
1991 @itemx --target=@var{bfdname}
1992 @cindex object code format
1993 Specify that the object-code format for the object files is
1994 @var{bfdname}. This option may not be necessary; @var{objdump} can
1995 automatically recognize many formats.
1999 objdump -b oasys -m vax -h fu.o
2002 displays summary information from the section headers (@option{-h}) of
2003 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2004 file in the format produced by Oasys compilers. You can list the
2005 formats available with the @option{-i} option.
2006 @xref{Target Selection}, for more information.
2009 @itemx --demangle[=@var{style}]
2010 @cindex demangling in objdump
2011 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2012 Besides removing any initial underscore prepended by the system, this
2013 makes C++ function names readable. Different compilers have different
2014 mangling styles. The optional demangling style argument can be used to
2015 choose an appropriate demangling style for your compiler. @xref{c++filt},
2016 for more information on demangling.
2020 Display debugging information. This attempts to parse STABS and IEEE
2021 debugging format information stored in the file and print it out using
2022 a C like syntax. If neither of these formats are found this option
2023 falls back on the @option{-W} option to print any DWARF information in
2027 @itemx --debugging-tags
2028 Like @option{-g}, but the information is generated in a format compatible
2032 @itemx --disassemble
2033 @cindex disassembling object code
2034 @cindex machine instructions
2035 Display the assembler mnemonics for the machine instructions from
2036 @var{objfile}. This option only disassembles those sections which are
2037 expected to contain instructions.
2040 @itemx --disassemble-all
2041 Like @option{-d}, but disassemble the contents of all sections, not just
2042 those expected to contain instructions.
2044 If the target is an ARM architecture this switch also has the effect
2045 of forcing the disassembler to decode pieces of data found in code
2046 sections as if they were instructions.
2048 @item --prefix-addresses
2049 When disassembling, print the complete address on each line. This is
2050 the older disassembly format.
2054 @itemx --endian=@{big|little@}
2056 @cindex disassembly endianness
2057 Specify the endianness of the object files. This only affects
2058 disassembly. This can be useful when disassembling a file format which
2059 does not describe endianness information, such as S-records.
2062 @itemx --file-headers
2063 @cindex object file header
2064 Display summary information from the overall header of
2065 each of the @var{objfile} files.
2068 @itemx --file-offsets
2069 @cindex object file offsets
2070 When disassembling sections, whenever a symbol is displayed, also
2071 display the file offset of the region of data that is about to be
2072 dumped. If zeroes are being skipped, then when disassembly resumes,
2073 tell the user how many zeroes were skipped and the file offset of the
2074 location from where the disassembly resumes. When dumping sections,
2075 display the file offset of the location from where the dump starts.
2077 @item --file-start-context
2078 @cindex source code context
2079 Specify that when displaying interlisted source code/disassembly
2080 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2081 context to the start of the file.
2084 @itemx --section-headers
2086 @cindex section headers
2087 Display summary information from the section headers of the
2090 File segments may be relocated to nonstandard addresses, for example by
2091 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2092 @command{ld}. However, some object file formats, such as a.out, do not
2093 store the starting address of the file segments. In those situations,
2094 although @command{ld} relocates the sections correctly, using @samp{objdump
2095 -h} to list the file section headers cannot show the correct addresses.
2096 Instead, it shows the usual addresses, which are implicit for the
2101 Print a summary of the options to @command{objdump} and exit.
2105 @cindex architectures available
2106 @cindex object formats available
2107 Display a list showing all architectures and object formats available
2108 for specification with @option{-b} or @option{-m}.
2111 @itemx --section=@var{name}
2112 @cindex section information
2113 Display information only for section @var{name}.
2116 @itemx --line-numbers
2117 @cindex source filenames for object files
2118 Label the display (using debugging information) with the filename and
2119 source line numbers corresponding to the object code or relocs shown.
2120 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2122 @item -m @var{machine}
2123 @itemx --architecture=@var{machine}
2124 @cindex architecture
2125 @cindex disassembly architecture
2126 Specify the architecture to use when disassembling object files. This
2127 can be useful when disassembling object files which do not describe
2128 architecture information, such as S-records. You can list the available
2129 architectures with the @option{-i} option.
2131 If the target is an ARM architecture then this switch has an
2132 additional effect. It restricts the disassembly to only those
2133 instructions supported by the architecture specified by @var{machine}.
2134 If it is necessary to use this switch because the input file does not
2135 contain any architecture information, but it is also desired to
2136 disassemble all the instructions use @option{-marm}.
2138 @item -M @var{options}
2139 @itemx --disassembler-options=@var{options}
2140 Pass target specific information to the disassembler. Only supported on
2141 some targets. If it is necessary to specify more than one
2142 disassembler option then multiple @option{-M} options can be used or
2143 can be placed together into a comma separated list.
2145 If the target is an ARM architecture then this switch can be used to
2146 select which register name set is used during disassembler. Specifying
2147 @option{-M reg-names-std} (the default) will select the register names as
2148 used in ARM's instruction set documentation, but with register 13 called
2149 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2150 @option{-M reg-names-apcs} will select the name set used by the ARM
2151 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2152 just use @samp{r} followed by the register number.
2154 There are also two variants on the APCS register naming scheme enabled
2155 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2156 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2157 with the normal register names or the special register names).
2159 This option can also be used for ARM architectures to force the
2160 disassembler to interpret all instructions as Thumb instructions by
2161 using the switch @option{--disassembler-options=force-thumb}. This can be
2162 useful when attempting to disassemble thumb code produced by other
2165 For the x86, some of the options duplicate functions of the @option{-m}
2166 switch, but allow finer grained control. Multiple selections from the
2167 following may be specified as a comma separated string.
2172 Select disassembly for the given architecture.
2176 Select between intel syntax mode and AT&T syntax mode.
2178 @item intel-mnemonic
2180 Select between intel mnemonic mode and AT&T mnemonic mode.
2181 Note: @code{intel-mnemonic} implies @code{intel} and
2182 @code{att-mnemonic} implies @code{att}.
2189 Specify the default address size and operand size. These four options
2190 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2191 appear later in the option string.
2194 When in AT&T mode, instructs the disassembler to print a mnemonic
2195 suffix even when the suffix could be inferred by the operands.
2198 For PowerPC, @option{booke} controls the disassembly of BookE
2199 instructions. @option{32} and @option{64} select PowerPC and
2200 PowerPC64 disassembly, respectively. @option{e300} selects
2201 disassembly for the e300 family. @option{440} selects disassembly for
2202 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2203 single instructions of the PPC750CL.
2205 For MIPS, this option controls the printing of instruction mnemonic
2206 names and register names in disassembled instructions. Multiple
2207 selections from the following may be specified as a comma separated
2208 string, and invalid options are ignored:
2212 Print the 'raw' instruction mnemonic instead of some pseudo
2213 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2214 'sll' instead of 'nop', etc.
2217 Disassemble MSA instructions.
2220 Disassemble the virtualization ASE instructions.
2223 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2225 @item gpr-names=@var{ABI}
2226 Print GPR (general-purpose register) names as appropriate
2227 for the specified ABI. By default, GPR names are selected according to
2228 the ABI of the binary being disassembled.
2230 @item fpr-names=@var{ABI}
2231 Print FPR (floating-point register) names as
2232 appropriate for the specified ABI. By default, FPR numbers are printed
2235 @item cp0-names=@var{ARCH}
2236 Print CP0 (system control coprocessor; coprocessor 0) register names
2237 as appropriate for the CPU or architecture specified by
2238 @var{ARCH}. By default, CP0 register names are selected according to
2239 the architecture and CPU of the binary being disassembled.
2241 @item hwr-names=@var{ARCH}
2242 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2243 as appropriate for the CPU or architecture specified by
2244 @var{ARCH}. By default, HWR names are selected according to
2245 the architecture and CPU of the binary being disassembled.
2247 @item reg-names=@var{ABI}
2248 Print GPR and FPR names as appropriate for the selected ABI.
2250 @item reg-names=@var{ARCH}
2251 Print CPU-specific register names (CP0 register and HWR names)
2252 as appropriate for the selected CPU or architecture.
2255 For any of the options listed above, @var{ABI} or
2256 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2257 rather than names, for the selected types of registers.
2258 You can list the available values of @var{ABI} and @var{ARCH} using
2259 the @option{--help} option.
2261 For VAX, you can specify function entry addresses with @option{-M
2262 entry:0xf00ba}. You can use this multiple times to properly
2263 disassemble VAX binary files that don't contain symbol tables (like
2264 ROM dumps). In these cases, the function entry mask would otherwise
2265 be decoded as VAX instructions, which would probably lead the rest
2266 of the function being wrongly disassembled.
2269 @itemx --private-headers
2270 Print information that is specific to the object file format. The exact
2271 information printed depends upon the object file format. For some
2272 object file formats, no additional information is printed.
2274 @item -P @var{options}
2275 @itemx --private=@var{options}
2276 Print information that is specific to the object file format. The
2277 argument @var{options} is a comma separated list that depends on the
2278 format (the lists of options is displayed with the help).
2280 For XCOFF, the available options are:
2296 Not all object formats support this option. In particular the ELF
2297 format does not use it.
2301 @cindex relocation entries, in object file
2302 Print the relocation entries of the file. If used with @option{-d} or
2303 @option{-D}, the relocations are printed interspersed with the
2307 @itemx --dynamic-reloc
2308 @cindex dynamic relocation entries, in object file
2309 Print the dynamic relocation entries of the file. This is only
2310 meaningful for dynamic objects, such as certain types of shared
2311 libraries. As for @option{-r}, if used with @option{-d} or
2312 @option{-D}, the relocations are printed interspersed with the
2316 @itemx --full-contents
2317 @cindex sections, full contents
2318 @cindex object file sections
2319 Display the full contents of any sections requested. By default all
2320 non-empty sections are displayed.
2324 @cindex source disassembly
2325 @cindex disassembly, with source
2326 Display source code intermixed with disassembly, if possible. Implies
2329 @item --prefix=@var{prefix}
2330 @cindex Add prefix to absolute paths
2331 Specify @var{prefix} to add to the absolute paths when used with
2334 @item --prefix-strip=@var{level}
2335 @cindex Strip absolute paths
2336 Indicate how many initial directory names to strip off the hardwired
2337 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2339 @item --show-raw-insn
2340 When disassembling instructions, print the instruction in hex as well as
2341 in symbolic form. This is the default except when
2342 @option{--prefix-addresses} is used.
2344 @item --no-show-raw-insn
2345 When disassembling instructions, do not print the instruction bytes.
2346 This is the default when @option{--prefix-addresses} is used.
2348 @item --insn-width=@var{width}
2349 @cindex Instruction width
2350 Display @var{width} bytes on a single line when disassembling
2353 @item -W[lLiaprmfFsoRt]
2354 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames]
2355 @itemx --dwarf[=aranges,=macro,=frames,=frames-interp,=str,=loc]
2356 @itemx --dwarf[=Ranges,=pubtypes,=trace_info,=trace_abbrev]
2357 @itemx --dwarf[=trace_aranges,=gdb_index]
2359 @cindex debug symbols
2360 Displays the contents of the debug sections in the file, if any are
2361 present. If one of the optional letters or words follows the switch
2362 then only data found in those specific sections will be dumped.
2364 Note that there is no single letter option to display the content of
2365 trace sections or .gdb_index.
2367 Note: the output from the @option{=info} option can also be affected
2368 by the options @option{--dwarf-depth}, the @option{--dwarf-start} and
2369 the @option{--dwarf-check}.
2371 @item --dwarf-depth=@var{n}
2372 Limit the dump of the @code{.debug_info} section to @var{n} children.
2373 This is only useful with @option{--dwarf=info}. The default is
2374 to print all DIEs; the special value 0 for @var{n} will also have this
2377 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2378 levels will not be printed. The range for @var{n} is zero-based.
2380 @item --dwarf-start=@var{n}
2381 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2382 useful with @option{--dwarf=info}.
2384 If specified, this option will suppress printing of any header
2385 information and all DIEs before the DIE numbered @var{n}. Only
2386 siblings and children of the specified DIE will be printed.
2388 This can be used in conjunction with @option{--dwarf-depth}.
2391 Enable additional checks for consistency of Dwarf information.
2397 @cindex debug symbols
2398 @cindex ELF object file format
2399 Display the full contents of any sections requested. Display the
2400 contents of the .stab and .stab.index and .stab.excl sections from an
2401 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2402 @code{.stab} debugging symbol-table entries are carried in an ELF
2403 section. In most other file formats, debugging symbol-table entries are
2404 interleaved with linkage symbols, and are visible in the @option{--syms}
2407 @item --start-address=@var{address}
2408 @cindex start-address
2409 Start displaying data at the specified address. This affects the output
2410 of the @option{-d}, @option{-r} and @option{-s} options.
2412 @item --stop-address=@var{address}
2413 @cindex stop-address
2414 Stop displaying data at the specified address. This affects the output
2415 of the @option{-d}, @option{-r} and @option{-s} options.
2419 @cindex symbol table entries, printing
2420 Print the symbol table entries of the file.
2421 This is similar to the information provided by the @samp{nm} program,
2422 although the display format is different. The format of the output
2423 depends upon the format of the file being dumped, but there are two main
2424 types. One looks like this:
2427 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2428 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2431 where the number inside the square brackets is the number of the entry
2432 in the symbol table, the @var{sec} number is the section number, the
2433 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2434 symbol's type, the @var{scl} number is the symbol's storage class and
2435 the @var{nx} value is the number of auxilary entries associated with
2436 the symbol. The last two fields are the symbol's value and its name.
2438 The other common output format, usually seen with ELF based files,
2442 00000000 l d .bss 00000000 .bss
2443 00000000 g .text 00000000 fred
2446 Here the first number is the symbol's value (sometimes refered to as
2447 its address). The next field is actually a set of characters and
2448 spaces indicating the flag bits that are set on the symbol. These
2449 characters are described below. Next is the section with which the
2450 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2451 not connected with any section), or @emph{*UND*} if the section is
2452 referenced in the file being dumped, but not defined there.
2454 After the section name comes another field, a number, which for common
2455 symbols is the alignment and for other symbol is the size. Finally
2456 the symbol's name is displayed.
2458 The flag characters are divided into 7 groups as follows:
2464 The symbol is a local (l), global (g), unique global (u), neither
2465 global nor local (a space) or both global and local (!). A
2466 symbol can be neither local or global for a variety of reasons, e.g.,
2467 because it is used for debugging, but it is probably an indication of
2468 a bug if it is ever both local and global. Unique global symbols are
2469 a GNU extension to the standard set of ELF symbol bindings. For such
2470 a symbol the dynamic linker will make sure that in the entire process
2471 there is just one symbol with this name and type in use.
2474 The symbol is weak (w) or strong (a space).
2477 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2480 The symbol is a warning (W) or a normal symbol (a space). A warning
2481 symbol's name is a message to be displayed if the symbol following the
2482 warning symbol is ever referenced.
2486 The symbol is an indirect reference to another symbol (I), a function
2487 to be evaluated during reloc processing (i) or a normal symbol (a
2492 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2493 normal symbol (a space).
2498 The symbol is the name of a function (F) or a file (f) or an object
2499 (O) or just a normal symbol (a space).
2503 @itemx --dynamic-syms
2504 @cindex dynamic symbol table entries, printing
2505 Print the dynamic symbol table entries of the file. This is only
2506 meaningful for dynamic objects, such as certain types of shared
2507 libraries. This is similar to the information provided by the @samp{nm}
2508 program when given the @option{-D} (@option{--dynamic}) option.
2510 @item --special-syms
2511 When displaying symbols include those which the target considers to be
2512 special in some way and which would not normally be of interest to the
2517 Print the version number of @command{objdump} and exit.
2520 @itemx --all-headers
2521 @cindex all header information, object file
2522 @cindex header information, all
2523 Display all available header information, including the symbol table and
2524 relocation entries. Using @option{-x} is equivalent to specifying all of
2525 @option{-a -f -h -p -r -t}.
2529 @cindex wide output, printing
2530 Format some lines for output devices that have more than 80 columns.
2531 Also do not truncate symbol names when they are displayed.
2534 @itemx --disassemble-zeroes
2535 Normally the disassembly output will skip blocks of zeroes. This
2536 option directs the disassembler to disassemble those blocks, just like
2543 @c man begin SEEALSO objdump
2544 nm(1), readelf(1), and the Info entries for @file{binutils}.
2552 @cindex archive contents
2553 @cindex symbol index
2555 @c man title ranlib generate index to archive.
2558 @c man begin SYNOPSIS ranlib
2559 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2563 @c man begin DESCRIPTION ranlib
2565 @command{ranlib} generates an index to the contents of an archive and
2566 stores it in the archive. The index lists each symbol defined by a
2567 member of an archive that is a relocatable object file.
2569 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2571 An archive with such an index speeds up linking to the library and
2572 allows routines in the library to call each other without regard to
2573 their placement in the archive.
2575 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2576 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2581 @c man begin OPTIONS ranlib
2587 Show usage information for @command{ranlib}.
2592 Show the version number of @command{ranlib}.
2595 @cindex deterministic archives
2596 @kindex --enable-deterministic-archives
2597 Operate in @emph{deterministic} mode. The symbol map archive member's
2598 header will show zero for the UID, GID, and timestamp. When this
2599 option is used, multiple runs will produce identical output files.
2601 If @file{binutils} was configured with
2602 @option{--enable-deterministic-archives}, then this mode is on by
2603 default. It can be disabled with the @samp{-U} option, described
2607 Update the timestamp of the symbol map of an archive.
2610 @cindex deterministic archives
2611 @kindex --enable-deterministic-archives
2612 Do @emph{not} operate in @emph{deterministic} mode. This is the
2613 inverse of the @samp{-D} option, above: the archive index will get
2614 actual UID, GID, timestamp, and file mode values.
2616 If @file{binutils} was configured @emph{without}
2617 @option{--enable-deterministic-archives}, then this mode is on by
2625 @c man begin SEEALSO ranlib
2626 ar(1), nm(1), and the Info entries for @file{binutils}.
2634 @cindex section sizes
2636 @c man title size list section sizes and total size.
2639 @c man begin SYNOPSIS size
2640 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2642 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2644 [@option{-t}|@option{--totals}]
2645 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2646 [@var{objfile}@dots{}]
2650 @c man begin DESCRIPTION size
2652 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2653 size---for each of the object or archive files @var{objfile} in its
2654 argument list. By default, one line of output is generated for each
2655 object file or each module in an archive.
2657 @var{objfile}@dots{} are the object files to be examined.
2658 If none are specified, the file @code{a.out} will be used.
2662 @c man begin OPTIONS size
2664 The command line options have the following meanings:
2669 @itemx --format=@var{compatibility}
2670 @cindex @command{size} display format
2671 Using one of these options, you can choose whether the output from @sc{gnu}
2672 @command{size} resembles output from System V @command{size} (using @option{-A},
2673 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2674 @option{--format=berkeley}). The default is the one-line format similar to
2676 @c Bonus for doc-source readers: you can also say --format=strange (or
2677 @c anything else that starts with 's') for sysv, and --format=boring (or
2678 @c anything else that starts with 'b') for Berkeley.
2680 Here is an example of the Berkeley (default) format of output from
2683 $ size --format=Berkeley ranlib size
2684 text data bss dec hex filename
2685 294880 81920 11592 388392 5ed28 ranlib
2686 294880 81920 11888 388688 5ee50 size
2690 This is the same data, but displayed closer to System V conventions:
2693 $ size --format=SysV ranlib size
2711 Show a summary of acceptable arguments and options.
2716 @itemx --radix=@var{number}
2717 @cindex @command{size} number format
2718 @cindex radix for section sizes
2719 Using one of these options, you can control whether the size of each
2720 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2721 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2722 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2723 values (8, 10, 16) are supported. The total size is always given in two
2724 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2725 octal and hexadecimal if you're using @option{-o}.
2728 Print total size of common symbols in each file. When using Berkeley
2729 format these are included in the bss size.
2733 Show totals of all objects listed (Berkeley format listing mode only).
2735 @item --target=@var{bfdname}
2736 @cindex object code format
2737 Specify that the object-code format for @var{objfile} is
2738 @var{bfdname}. This option may not be necessary; @command{size} can
2739 automatically recognize many formats.
2740 @xref{Target Selection}, for more information.
2744 Display the version number of @command{size}.
2750 @c man begin SEEALSO size
2751 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2758 @cindex listings strings
2759 @cindex printing strings
2760 @cindex strings, printing
2762 @c man title strings print the strings of printable characters in files.
2765 @c man begin SYNOPSIS strings
2766 strings [@option{-afovV}] [@option{-}@var{min-len}]
2767 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2768 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2769 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2770 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2771 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2772 [@option{-w}] [@option{--include-all-whitespace}]
2773 [@option{--help}] [@option{--version}] @var{file}@dots{}
2777 @c man begin DESCRIPTION strings
2779 For each @var{file} given, @sc{gnu} @command{strings} prints the
2780 printable character sequences that are at least 4 characters long (or
2781 the number given with the options below) and are followed by an
2782 unprintable character.
2784 Depending upon how the strings program was configured it will default
2785 to either displaying all the printable sequences that it can find in
2786 each file, or only those sequences that are in loadable, initialized
2787 data sections. If the file type in unrecognizable, or if strings is
2788 reading from stdin then it will always display all of the printable
2789 sequences that it can find.
2791 For backwards compatibility any file that occurs after a command line
2792 option of just @option{-} will also be scanned in full, regardless of
2793 the presence of any @option{-d} option.
2795 @command{strings} is mainly useful for determining the contents of
2800 @c man begin OPTIONS strings
2806 Scan the whole file, regardless of what sections it contains or
2807 whether those sections are loaded or initialized. Normally this is
2808 the default behaviour, but strings can be configured so that the
2809 @option{-d} is the default instead.
2811 The @option{-} option is position dependent and forces strings to
2812 perform full scans of any file that is mentioned after the @option{-}
2813 on the command line, even if the @option{-d} option has been
2818 Only print strings from initialized, loaded data sections in the
2819 file. This may reduce the amount of garbage in the output, but it
2820 also exposes the strings program to any security flaws that may be
2821 present in the BFD library used to scan and load sections. Strings
2822 can be configured so that this option is the default behaviour. In
2823 such cases the @option{-a} option can be used to avoid using the BFD
2824 library and instead just print all of the strings found in the file.
2827 @itemx --print-file-name
2828 Print the name of the file before each string.
2831 Print a summary of the program usage on the standard output and exit.
2833 @item -@var{min-len}
2834 @itemx -n @var{min-len}
2835 @itemx --bytes=@var{min-len}
2836 Print sequences of characters that are at least @var{min-len} characters
2837 long, instead of the default 4.
2840 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2841 act like @samp{-t d} instead. Since we can not be compatible with both
2842 ways, we simply chose one.
2844 @item -t @var{radix}
2845 @itemx --radix=@var{radix}
2846 Print the offset within the file before each string. The single
2847 character argument specifies the radix of the offset---@samp{o} for
2848 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2850 @item -e @var{encoding}
2851 @itemx --encoding=@var{encoding}
2852 Select the character encoding of the strings that are to be found.
2853 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2854 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2855 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2856 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2857 littleendian. Useful for finding wide character strings. (@samp{l}
2858 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2860 @item -T @var{bfdname}
2861 @itemx --target=@var{bfdname}
2862 @cindex object code format
2863 Specify an object code format other than your system's default format.
2864 @xref{Target Selection}, for more information.
2869 Print the program version number on the standard output and exit.
2872 @itemx --include-all-whitespace
2873 By default tab and space characters are included in the strings that
2874 are displayed, but other whitespace characters, such a newlines and
2875 carriage returns, are not. The @option{-w} option changes this so
2876 that all whitespace characters are considered to be part of a string.
2882 @c man begin SEEALSO strings
2883 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2884 and the Info entries for @file{binutils}.
2892 @cindex removing symbols
2893 @cindex discarding symbols
2894 @cindex symbols, discarding
2896 @c man title strip Discard symbols from object files.
2899 @c man begin SYNOPSIS strip
2900 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2901 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2902 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2903 [@option{-s}|@option{--strip-all}]
2904 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2905 [@option{--strip-dwo}]
2906 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2907 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2908 [@option{-w}|@option{--wildcard}]
2909 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2910 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2911 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2912 [@option{-D}|@option{--enable-deterministic-archives}]
2913 [@option{-U}|@option{--disable-deterministic-archives}]
2914 [@option{--keep-file-symbols}]
2915 [@option{--only-keep-debug}]
2916 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2917 [@option{--help}] [@option{--info}]
2918 @var{objfile}@dots{}
2922 @c man begin DESCRIPTION strip
2924 @sc{gnu} @command{strip} discards all symbols from object files
2925 @var{objfile}. The list of object files may include archives.
2926 At least one object file must be given.
2928 @command{strip} modifies the files named in its argument,
2929 rather than writing modified copies under different names.
2933 @c man begin OPTIONS strip
2936 @item -F @var{bfdname}
2937 @itemx --target=@var{bfdname}
2938 Treat the original @var{objfile} as a file with the object
2939 code format @var{bfdname}, and rewrite it in the same format.
2940 @xref{Target Selection}, for more information.
2943 Show a summary of the options to @command{strip} and exit.
2946 Display a list showing all architectures and object formats available.
2948 @item -I @var{bfdname}
2949 @itemx --input-target=@var{bfdname}
2950 Treat the original @var{objfile} as a file with the object
2951 code format @var{bfdname}.
2952 @xref{Target Selection}, for more information.
2954 @item -O @var{bfdname}
2955 @itemx --output-target=@var{bfdname}
2956 Replace @var{objfile} with a file in the output format @var{bfdname}.
2957 @xref{Target Selection}, for more information.
2959 @item -R @var{sectionname}
2960 @itemx --remove-section=@var{sectionname}
2961 Remove any section named @var{sectionname} from the output file, in
2962 addition to whatever sections would otherwise be removed. This
2963 option may be given more than once. Note that using this option
2964 inappropriately may make the output file unusable. The wildcard
2965 character @samp{*} may be given at the end of @var{sectionname}. If
2966 so, then any section starting with @var{sectionname} will be removed.
2975 @itemx --strip-debug
2976 Remove debugging symbols only.
2979 Remove the contents of all DWARF .dwo sections, leaving the
2980 remaining debugging sections and all symbols intact.
2981 See the description of this option in the @command{objcopy} section
2982 for more information.
2984 @item --strip-unneeded
2985 Remove all symbols that are not needed for relocation processing.
2987 @item -K @var{symbolname}
2988 @itemx --keep-symbol=@var{symbolname}
2989 When stripping symbols, keep symbol @var{symbolname} even if it would
2990 normally be stripped. This option may be given more than once.
2992 @item -N @var{symbolname}
2993 @itemx --strip-symbol=@var{symbolname}
2994 Remove symbol @var{symbolname} from the source file. This option may be
2995 given more than once, and may be combined with strip options other than
2999 Put the stripped output in @var{file}, rather than replacing the
3000 existing file. When this argument is used, only one @var{objfile}
3001 argument may be specified.
3004 @itemx --preserve-dates
3005 Preserve the access and modification dates of the file.
3008 @itemx --enable-deterministic-archives
3009 @cindex deterministic archives
3010 @kindex --enable-deterministic-archives
3011 Operate in @emph{deterministic} mode. When copying archive members
3012 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3013 and use consistent file modes for all files.
3015 If @file{binutils} was configured with
3016 @option{--enable-deterministic-archives}, then this mode is on by default.
3017 It can be disabled with the @samp{-U} option, below.
3020 @itemx --disable-deterministic-archives
3021 @cindex deterministic archives
3022 @kindex --enable-deterministic-archives
3023 Do @emph{not} operate in @emph{deterministic} mode. This is the
3024 inverse of the @option{-D} option, above: when copying archive members
3025 and writing the archive index, use their actual UID, GID, timestamp,
3026 and file mode values.
3028 This is the default unless @file{binutils} was configured with
3029 @option{--enable-deterministic-archives}.
3033 Permit regular expressions in @var{symbolname}s used in other command
3034 line options. The question mark (?), asterisk (*), backslash (\) and
3035 square brackets ([]) operators can be used anywhere in the symbol
3036 name. If the first character of the symbol name is the exclamation
3037 point (!) then the sense of the switch is reversed for that symbol.
3044 would cause strip to only keep symbols that start with the letters
3045 ``fo'', but to discard the symbol ``foo''.
3048 @itemx --discard-all
3049 Remove non-global symbols.
3052 @itemx --discard-locals
3053 Remove compiler-generated local symbols.
3054 (These usually start with @samp{L} or @samp{.}.)
3056 @item --keep-file-symbols
3057 When stripping a file, perhaps with @option{--strip-debug} or
3058 @option{--strip-unneeded}, retain any symbols specifying source file names,
3059 which would otherwise get stripped.
3061 @item --only-keep-debug
3062 Strip a file, removing contents of any sections that would not be
3063 stripped by @option{--strip-debug} and leaving the debugging sections
3064 intact. In ELF files, this preserves all note sections in the output.
3066 The intention is that this option will be used in conjunction with
3067 @option{--add-gnu-debuglink} to create a two part executable. One a
3068 stripped binary which will occupy less space in RAM and in a
3069 distribution and the second a debugging information file which is only
3070 needed if debugging abilities are required. The suggested procedure
3071 to create these files is as follows:
3074 @item Link the executable as normal. Assuming that is is called
3076 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3077 create a file containing the debugging info.
3078 @item Run @code{objcopy --strip-debug foo} to create a
3079 stripped executable.
3080 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3081 to add a link to the debugging info into the stripped executable.
3084 Note---the choice of @code{.dbg} as an extension for the debug info
3085 file is arbitrary. Also the @code{--only-keep-debug} step is
3086 optional. You could instead do this:
3089 @item Link the executable as normal.
3090 @item Copy @code{foo} to @code{foo.full}
3091 @item Run @code{strip --strip-debug foo}
3092 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3095 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3096 full executable. It does not have to be a file created by the
3097 @option{--only-keep-debug} switch.
3099 Note---this switch is only intended for use on fully linked files. It
3100 does not make sense to use it on object files where the debugging
3101 information may be incomplete. Besides the gnu_debuglink feature
3102 currently only supports the presence of one filename containing
3103 debugging information, not multiple filenames on a one-per-object-file
3108 Show the version number for @command{strip}.
3112 Verbose output: list all object files modified. In the case of
3113 archives, @samp{strip -v} lists all members of the archive.
3119 @c man begin SEEALSO strip
3120 the Info entries for @file{binutils}.
3124 @node c++filt, addr2line, strip, Top
3128 @cindex demangling C++ symbols
3130 @c man title cxxfilt Demangle C++ and Java symbols.
3133 @c man begin SYNOPSIS cxxfilt
3134 c++filt [@option{-_}|@option{--strip-underscore}]
3135 [@option{-n}|@option{--no-strip-underscore}]
3136 [@option{-p}|@option{--no-params}]
3137 [@option{-t}|@option{--types}]
3138 [@option{-i}|@option{--no-verbose}]
3139 [@option{-s} @var{format}|@option{--format=}@var{format}]
3140 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
3144 @c man begin DESCRIPTION cxxfilt
3147 The C++ and Java languages provide function overloading, which means
3148 that you can write many functions with the same name, providing that
3149 each function takes parameters of different types. In order to be
3150 able to distinguish these similarly named functions C++ and Java
3151 encode them into a low-level assembler name which uniquely identifies
3152 each different version. This process is known as @dfn{mangling}. The
3154 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3155 MS-DOS this program is named @command{CXXFILT}.}
3156 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3157 names into user-level names so that they can be read.
3159 Every alphanumeric word (consisting of letters, digits, underscores,
3160 dollars, or periods) seen in the input is a potential mangled name.
3161 If the name decodes into a C++ name, the C++ name replaces the
3162 low-level name in the output, otherwise the original word is output.
3163 In this way you can pass an entire assembler source file, containing
3164 mangled names, through @command{c++filt} and see the same source file
3165 containing demangled names.
3167 You can also use @command{c++filt} to decipher individual symbols by
3168 passing them on the command line:
3171 c++filt @var{symbol}
3174 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3175 names from the standard input instead. All the results are printed on
3176 the standard output. The difference between reading names from the
3177 command line versus reading names from the standard input is that
3178 command line arguments are expected to be just mangled names and no
3179 checking is performed to separate them from surrounding text. Thus
3186 will work and demangle the name to ``f()'' whereas:
3192 will not work. (Note the extra comma at the end of the mangled
3193 name which makes it invalid). This command however will work:
3196 echo _Z1fv, | c++filt -n
3199 and will display ``f(),'', i.e., the demangled name followed by a
3200 trailing comma. This behaviour is because when the names are read
3201 from the standard input it is expected that they might be part of an
3202 assembler source file where there might be extra, extraneous
3203 characters trailing after a mangled name. For example:
3206 .type _Z1fv, @@function
3211 @c man begin OPTIONS cxxfilt
3215 @itemx --strip-underscore
3216 On some systems, both the C and C++ compilers put an underscore in front
3217 of every name. For example, the C name @code{foo} gets the low-level
3218 name @code{_foo}. This option removes the initial underscore. Whether
3219 @command{c++filt} removes the underscore by default is target dependent.
3222 @itemx --no-strip-underscore
3223 Do not remove the initial underscore.
3227 When demangling the name of a function, do not display the types of
3228 the function's parameters.
3232 Attempt to demangle types as well as function names. This is disabled
3233 by default since mangled types are normally only used internally in
3234 the compiler, and they can be confused with non-mangled names. For example,
3235 a function called ``a'' treated as a mangled type name would be
3236 demangled to ``signed char''.
3240 Do not include implementation details (if any) in the demangled
3243 @item -s @var{format}
3244 @itemx --format=@var{format}
3245 @command{c++filt} can decode various methods of mangling, used by
3246 different compilers. The argument to this option selects which
3251 Automatic selection based on executable (the default method)
3253 the one used by the @sc{gnu} C++ compiler (g++)
3255 the one used by the Lucid compiler (lcc)
3257 the one specified by the C++ Annotated Reference Manual
3259 the one used by the HP compiler (aCC)
3261 the one used by the EDG compiler
3263 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3265 the one used by the @sc{gnu} Java compiler (gcj)
3267 the one used by the @sc{gnu} Ada compiler (GNAT).
3271 Print a summary of the options to @command{c++filt} and exit.
3274 Print the version number of @command{c++filt} and exit.
3280 @c man begin SEEALSO cxxfilt
3281 the Info entries for @file{binutils}.
3286 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3287 user interface are subject to change in future releases. In particular,
3288 a command-line option may be required in the future to decode a name
3289 passed as an argument on the command line; in other words,
3292 c++filt @var{symbol}
3296 may in a future release become
3299 c++filt @var{option} @var{symbol}
3307 @cindex address to file name and line number
3309 @c man title addr2line convert addresses into file names and line numbers.
3312 @c man begin SYNOPSIS addr2line
3313 addr2line [@option{-a}|@option{--addresses}]
3314 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3315 [@option{-C}|@option{--demangle}[=@var{style}]]
3316 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3317 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3318 [@option{-i}|@option{--inlines}]
3319 [@option{-p}|@option{--pretty-print}]
3320 [@option{-j}|@option{--section=}@var{name}]
3321 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3326 @c man begin DESCRIPTION addr2line
3328 @command{addr2line} translates addresses into file names and line numbers.
3329 Given an address in an executable or an offset in a section of a relocatable
3330 object, it uses the debugging information to figure out which file name and
3331 line number are associated with it.
3333 The executable or relocatable object to use is specified with the @option{-e}
3334 option. The default is the file @file{a.out}. The section in the relocatable
3335 object to use is specified with the @option{-j} option.
3337 @command{addr2line} has two modes of operation.
3339 In the first, hexadecimal addresses are specified on the command line,
3340 and @command{addr2line} displays the file name and line number for each
3343 In the second, @command{addr2line} reads hexadecimal addresses from
3344 standard input, and prints the file name and line number for each
3345 address on standard output. In this mode, @command{addr2line} may be used
3346 in a pipe to convert dynamically chosen addresses.
3348 The format of the output is @samp{FILENAME:LINENO}. By default
3349 each input address generates one line of output.
3351 Two options can generate additional lines before each
3352 @samp{FILENAME:LINENO} line (in that order).
3354 If the @option{-a} option is used then a line with the input address
3357 If the @option{-f} option is used, then a line with the
3358 @samp{FUNCTIONNAME} is displayed. This is the name of the function
3359 containing the address.
3361 One option can generate additional lines after the
3362 @samp{FILENAME:LINENO} line.
3364 If the @option{-i} option is used and the code at the given address is
3365 present there because of inlining by the compiler then additional
3366 lines are displayed afterwards. One or two extra lines (if the
3367 @option{-f} option is used) are displayed for each inlined function.
3369 Alternatively if the @option{-p} option is used then each input
3370 address generates a single, long, output line containing the address,
3371 the function name, the file name and the line number. If the
3372 @option{-i} option has also been used then any inlined functions will
3373 be displayed in the same manner, but on separate lines, and prefixed
3374 by the text @samp{(inlined by)}.
3376 If the file name or function name can not be determined,
3377 @command{addr2line} will print two question marks in their place. If the
3378 line number can not be determined, @command{addr2line} will print 0.
3382 @c man begin OPTIONS addr2line
3384 The long and short forms of options, shown here as alternatives, are
3390 Display the address before the function name, file and line number
3391 information. The address is printed with a @samp{0x} prefix to easily
3394 @item -b @var{bfdname}
3395 @itemx --target=@var{bfdname}
3396 @cindex object code format
3397 Specify that the object-code format for the object files is
3401 @itemx --demangle[=@var{style}]
3402 @cindex demangling in objdump
3403 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3404 Besides removing any initial underscore prepended by the system, this
3405 makes C++ function names readable. Different compilers have different
3406 mangling styles. The optional demangling style argument can be used to
3407 choose an appropriate demangling style for your compiler. @xref{c++filt},
3408 for more information on demangling.
3410 @item -e @var{filename}
3411 @itemx --exe=@var{filename}
3412 Specify the name of the executable for which addresses should be
3413 translated. The default file is @file{a.out}.
3417 Display function names as well as file and line number information.
3421 Display only the base of each file name.
3425 If the address belongs to a function that was inlined, the source
3426 information for all enclosing scopes back to the first non-inlined
3427 function will also be printed. For example, if @code{main} inlines
3428 @code{callee1} which inlines @code{callee2}, and address is from
3429 @code{callee2}, the source information for @code{callee1} and @code{main}
3430 will also be printed.
3434 Read offsets relative to the specified section instead of absolute addresses.
3437 @itemx --pretty-print
3438 Make the output more human friendly: each location are printed on one line.
3439 If option @option{-i} is specified, lines for all enclosing scopes are
3440 prefixed with @samp{(inlined by)}.
3446 @c man begin SEEALSO addr2line
3447 Info entries for @file{binutils}.
3454 @command{nlmconv} converts a relocatable object file into a NetWare
3458 @command{nlmconv} currently works with @samp{i386} object
3459 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3460 object files in @sc{elf}, or @code{a.out} format@footnote{
3461 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3462 format in the Binary File Descriptor library. It has only been tested
3463 with the above formats.}.
3467 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3468 utilities, since it is only useful for NLM targets.
3471 @c man title nlmconv converts object code into an NLM.
3474 @c man begin SYNOPSIS nlmconv
3475 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3476 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3477 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3478 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3479 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3480 @var{infile} @var{outfile}
3484 @c man begin DESCRIPTION nlmconv
3486 @command{nlmconv} converts the relocatable @samp{i386} object file
3487 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3488 reading @var{headerfile} for NLM header information. For instructions
3489 on writing the NLM command file language used in header files, see the
3490 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3491 Development and Tools Overview}, which is part of the NLM Software
3492 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3493 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3496 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3499 @command{nlmconv} can perform a link step. In other words, you can list
3500 more than one object file for input if you list them in the definitions
3501 file (rather than simply specifying one input file on the command line).
3502 In this case, @command{nlmconv} calls the linker for you.
3506 @c man begin OPTIONS nlmconv
3509 @item -I @var{bfdname}
3510 @itemx --input-target=@var{bfdname}
3511 Object format of the input file. @command{nlmconv} can usually determine
3512 the format of a given file (so no default is necessary).
3513 @xref{Target Selection}, for more information.
3515 @item -O @var{bfdname}
3516 @itemx --output-target=@var{bfdname}
3517 Object format of the output file. @command{nlmconv} infers the output
3518 format based on the input format, e.g. for a @samp{i386} input file the
3519 output format is @samp{nlm32-i386}.
3520 @xref{Target Selection}, for more information.
3522 @item -T @var{headerfile}
3523 @itemx --header-file=@var{headerfile}
3524 Reads @var{headerfile} for NLM header information. For instructions on
3525 writing the NLM command file language used in header files, see@ see the
3526 @samp{linkers} section, of the @cite{NLM Development and Tools
3527 Overview}, which is part of the NLM Software Developer's Kit, available
3532 Displays (on standard error) the linker command line used by @command{nlmconv}.
3534 @item -l @var{linker}
3535 @itemx --linker=@var{linker}
3536 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3541 Prints a usage summary.
3545 Prints the version number for @command{nlmconv}.
3551 @c man begin SEEALSO nlmconv
3552 the Info entries for @file{binutils}.
3559 @command{windmc} may be used to generator Windows message resources.
3562 @emph{Warning:} @command{windmc} is not always built as part of the binary
3563 utilities, since it is only useful for Windows targets.
3566 @c man title windmc generates Windows message resources.
3569 @c man begin SYNOPSIS windmc
3570 windmc [options] input-file
3574 @c man begin DESCRIPTION windmc
3576 @command{windmc} reads message definitions from an input file (.mc) and
3577 translate them into a set of output files. The output files may be of
3582 A C header file containing the message definitions.
3585 A resource file compilable by the @command{windres} tool.
3588 One or more binary files containing the resource data for a specific
3592 A C include file that maps message id's to their symbolic name.
3595 The exact description of these different formats is available in
3596 documentation from Microsoft.
3598 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3599 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3600 Windows Message Compiler.
3604 @c man begin OPTIONS windmc
3609 Specifies that the input file specified is ASCII. This is the default
3614 Specifies that messages in the output @code{bin} files should be in ASCII
3619 Specifies that @code{bin} filenames should have to be prefixed by the
3620 basename of the source file.
3624 Sets the customer bit in all message id's.
3626 @item -C @var{codepage}
3627 @itemx --codepage_in @var{codepage}
3628 Sets the default codepage to be used to convert input file to UTF16. The
3629 default is ocdepage 1252.
3632 @itemx --decimal_values
3633 Outputs the constants in the header file in decimal. Default is using
3637 @itemx --extension @var{ext}
3638 The extension for the header file. The default is .h extension.
3640 @item -F @var{target}
3641 @itemx --target @var{target}
3642 Specify the BFD format to use for a bin file as output. This
3643 is a BFD target name; you can use the @option{--help} option to see a list
3644 of supported targets. Normally @command{windmc} will use the default
3645 format, which is the first one listed by the @option{--help} option.
3647 @ref{Target Selection}.
3651 @itemx --headerdir @var{path}
3652 The target directory of the generated header file. The default is the
3657 Displays a list of command line options and then exits.
3659 @item -m @var{characters}
3660 @itemx --maxlength @var{characters}
3661 Instructs @command{windmc} to generate a warning if the length
3662 of any message exceeds the number specified.
3665 @itemx --nullterminate
3666 Terminate message text in @code{bin} files by zero. By default they are
3667 terminated by CR/LF.
3670 @itemx --hresult_use
3671 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3672 file, using HRESULT definitions. Status codes are used if the flag is not
3675 @item -O @var{codepage}
3676 @itemx --codepage_out @var{codepage}
3677 Sets the default codepage to be used to output text files. The default
3681 @itemx --rcdir @var{path}
3682 The target directory for the generated @code{rc} script and the generated
3683 @code{bin} files that the resource compiler script includes. The default
3684 is the current directory.
3688 Specifies that the input file is UTF16.
3691 @itemx --unicode_out
3692 Specifies that messages in the output @code{bin} file should be in UTF16
3693 format. This is the default behaviour.
3697 Enable verbose mode.
3701 Prints the version number for @command{windmc}.
3704 @itemx --xdgb @var{path}
3705 The path of the @code{dbg} C include file that maps message id's to the
3706 symbolic name. No such file is generated without specifying the switch.
3712 @c man begin SEEALSO windmc
3713 the Info entries for @file{binutils}.
3720 @command{windres} may be used to manipulate Windows resources.
3723 @emph{Warning:} @command{windres} is not always built as part of the binary
3724 utilities, since it is only useful for Windows targets.
3727 @c man title windres manipulate Windows resources.
3730 @c man begin SYNOPSIS windres
3731 windres [options] [input-file] [output-file]
3735 @c man begin DESCRIPTION windres
3737 @command{windres} reads resources from an input file and copies them into
3738 an output file. Either file may be in one of three formats:
3742 A text format read by the Resource Compiler.
3745 A binary format generated by the Resource Compiler.
3748 A COFF object or executable.
3751 The exact description of these different formats is available in
3752 documentation from Microsoft.
3754 When @command{windres} converts from the @code{rc} format to the @code{res}
3755 format, it is acting like the Windows Resource Compiler. When
3756 @command{windres} converts from the @code{res} format to the @code{coff}
3757 format, it is acting like the Windows @code{CVTRES} program.
3759 When @command{windres} generates an @code{rc} file, the output is similar
3760 but not identical to the format expected for the input. When an input
3761 @code{rc} file refers to an external filename, an output @code{rc} file
3762 will instead include the file contents.
3764 If the input or output format is not specified, @command{windres} will
3765 guess based on the file name, or, for the input file, the file contents.
3766 A file with an extension of @file{.rc} will be treated as an @code{rc}
3767 file, a file with an extension of @file{.res} will be treated as a
3768 @code{res} file, and a file with an extension of @file{.o} or
3769 @file{.exe} will be treated as a @code{coff} file.
3771 If no output file is specified, @command{windres} will print the resources
3772 in @code{rc} format to standard output.
3774 The normal use is for you to write an @code{rc} file, use @command{windres}
3775 to convert it to a COFF object file, and then link the COFF file into
3776 your application. This will make the resources described in the
3777 @code{rc} file available to Windows.
3781 @c man begin OPTIONS windres
3784 @item -i @var{filename}
3785 @itemx --input @var{filename}
3786 The name of the input file. If this option is not used, then
3787 @command{windres} will use the first non-option argument as the input file
3788 name. If there are no non-option arguments, then @command{windres} will
3789 read from standard input. @command{windres} can not read a COFF file from
3792 @item -o @var{filename}
3793 @itemx --output @var{filename}
3794 The name of the output file. If this option is not used, then
3795 @command{windres} will use the first non-option argument, after any used
3796 for the input file name, as the output file name. If there is no
3797 non-option argument, then @command{windres} will write to standard output.
3798 @command{windres} can not write a COFF file to standard output. Note,
3799 for compatibility with @command{rc} the option @option{-fo} is also
3800 accepted, but its use is not recommended.
3802 @item -J @var{format}
3803 @itemx --input-format @var{format}
3804 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3805 @samp{coff}. If no input format is specified, @command{windres} will
3806 guess, as described above.
3808 @item -O @var{format}
3809 @itemx --output-format @var{format}
3810 The output format to generate. @var{format} may be @samp{res},
3811 @samp{rc}, or @samp{coff}. If no output format is specified,
3812 @command{windres} will guess, as described above.
3814 @item -F @var{target}
3815 @itemx --target @var{target}
3816 Specify the BFD format to use for a COFF file as input or output. This
3817 is a BFD target name; you can use the @option{--help} option to see a list
3818 of supported targets. Normally @command{windres} will use the default
3819 format, which is the first one listed by the @option{--help} option.
3821 @ref{Target Selection}.
3824 @item --preprocessor @var{program}
3825 When @command{windres} reads an @code{rc} file, it runs it through the C
3826 preprocessor first. This option may be used to specify the preprocessor
3827 to use, including any leading arguments. The default preprocessor
3828 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3830 @item --preprocessor-arg @var{option}
3831 When @command{windres} reads an @code{rc} file, it runs it through
3832 the C preprocessor first. This option may be used to specify additional
3833 text to be passed to preprocessor on its command line.
3834 This option can be used multiple times to add multiple options to the
3835 preprocessor command line.
3837 @item -I @var{directory}
3838 @itemx --include-dir @var{directory}
3839 Specify an include directory to use when reading an @code{rc} file.
3840 @command{windres} will pass this to the preprocessor as an @option{-I}
3841 option. @command{windres} will also search this directory when looking for
3842 files named in the @code{rc} file. If the argument passed to this command
3843 matches any of the supported @var{formats} (as described in the @option{-J}
3844 option), it will issue a deprecation warning, and behave just like the
3845 @option{-J} option. New programs should not use this behaviour. If a
3846 directory happens to match a @var{format}, simple prefix it with @samp{./}
3847 to disable the backward compatibility.
3849 @item -D @var{target}
3850 @itemx --define @var{sym}[=@var{val}]
3851 Specify a @option{-D} option to pass to the preprocessor when reading an
3854 @item -U @var{target}
3855 @itemx --undefine @var{sym}
3856 Specify a @option{-U} option to pass to the preprocessor when reading an
3860 Ignored for compatibility with rc.
3863 Enable verbose mode. This tells you what the preprocessor is if you
3867 @item --codepage @var{val}
3868 Specify the default codepage to use when reading an @code{rc} file.
3869 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3870 codepage code. The valid range is from zero up to 0xffff, but the
3871 validity of the codepage is host and configuration dependent.
3874 @item --language @var{val}
3875 Specify the default language to use when reading an @code{rc} file.
3876 @var{val} should be a hexadecimal language code. The low eight bits are
3877 the language, and the high eight bits are the sublanguage.
3879 @item --use-temp-file
3880 Use a temporary file to instead of using popen to read the output of
3881 the preprocessor. Use this option if the popen implementation is buggy
3882 on the host (eg., certain non-English language versions of Windows 95 and
3883 Windows 98 are known to have buggy popen where the output will instead
3886 @item --no-use-temp-file
3887 Use popen, not a temporary file, to read the output of the preprocessor.
3888 This is the default behaviour.
3892 Prints a usage summary.
3896 Prints the version number for @command{windres}.
3899 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3900 this will turn on parser debugging.
3906 @c man begin SEEALSO windres
3907 the Info entries for @file{binutils}.
3916 @command{dlltool} is used to create the files needed to create dynamic
3917 link libraries (DLLs) on systems which understand PE format image
3918 files such as Windows. A DLL contains an export table which contains
3919 information that the runtime loader needs to resolve references from a
3920 referencing program.
3922 The export table is generated by this program by reading in a
3923 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3924 will be in the DLL. A @file{.o} file can contain information in
3925 special @samp{.drectve} sections with export information.
3928 @emph{Note:} @command{dlltool} is not always built as part of the
3929 binary utilities, since it is only useful for those targets which
3933 @c man title dlltool Create files needed to build and use DLLs.
3936 @c man begin SYNOPSIS dlltool
3937 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3938 [@option{-b}|@option{--base-file} @var{base-file-name}]
3939 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3940 [@option{-z}|@option{--output-def} @var{def-file-name}]
3941 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3942 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3943 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3944 [@option{--exclude-symbols} @var{list}]
3945 [@option{--no-default-excludes}]
3946 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3947 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3948 [@option{-a}|@option{--add-indirect}]
3949 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3950 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3951 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3952 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3953 [@option{--use-nul-prefixed-import-tables}]
3954 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3955 [@option{-i}|@option{--interwork}]
3956 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3957 [@option{-v}|@option{--verbose}]
3958 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3959 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
3960 [object-file @dots{}]
3964 @c man begin DESCRIPTION dlltool
3966 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3967 @option{-b} options as well as object files specified on the command
3968 line. It then processes these inputs and if the @option{-e} option has
3969 been specified it creates a exports file. If the @option{-l} option
3970 has been specified it creates a library file and if the @option{-z} option
3971 has been specified it creates a def file. Any or all of the @option{-e},
3972 @option{-l} and @option{-z} options can be present in one invocation of
3975 When creating a DLL, along with the source for the DLL, it is necessary
3976 to have three other files. @command{dlltool} can help with the creation of
3979 The first file is a @file{.def} file which specifies which functions are
3980 exported from the DLL, which functions the DLL imports, and so on. This
3981 is a text file and can be created by hand, or @command{dlltool} can be used
3982 to create it using the @option{-z} option. In this case @command{dlltool}
3983 will scan the object files specified on its command line looking for
3984 those functions which have been specially marked as being exported and
3985 put entries for them in the @file{.def} file it creates.
3987 In order to mark a function as being exported from a DLL, it needs to
3988 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3989 section of the object file. This can be done in C by using the
3993 asm (".section .drectve");
3994 asm (".ascii \"-export:my_func\"");
3996 int my_func (void) @{ @dots{} @}
3999 The second file needed for DLL creation is an exports file. This file
4000 is linked with the object files that make up the body of the DLL and it
4001 handles the interface between the DLL and the outside world. This is a
4002 binary file and it can be created by giving the @option{-e} option to
4003 @command{dlltool} when it is creating or reading in a @file{.def} file.
4005 The third file needed for DLL creation is the library file that programs
4006 will link with in order to access the functions in the DLL (an `import
4007 library'). This file can be created by giving the @option{-l} option to
4008 dlltool when it is creating or reading in a @file{.def} file.
4010 If the @option{-y} option is specified, dlltool generates a delay-import
4011 library that can be used instead of the normal import library to allow
4012 a program to link to the dll only as soon as an imported function is
4013 called for the first time. The resulting executable will need to be
4014 linked to the static delayimp library containing __delayLoadHelper2(),
4015 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4017 @command{dlltool} builds the library file by hand, but it builds the
4018 exports file by creating temporary files containing assembler statements
4019 and then assembling these. The @option{-S} command line option can be
4020 used to specify the path to the assembler that dlltool will use,
4021 and the @option{-f} option can be used to pass specific flags to that
4022 assembler. The @option{-n} can be used to prevent dlltool from deleting
4023 these temporary assembler files when it is done, and if @option{-n} is
4024 specified twice then this will prevent dlltool from deleting the
4025 temporary object files it used to build the library.
4027 Here is an example of creating a DLL from a source file @samp{dll.c} and
4028 also creating a program (from an object file called @samp{program.o})
4033 dlltool -e exports.o -l dll.lib dll.o
4034 gcc dll.o exports.o -o dll.dll
4035 gcc program.o dll.lib -o program
4039 @command{dlltool} may also be used to query an existing import library
4040 to determine the name of the DLL to which it is associated. See the
4041 description of the @option{-I} or @option{--identify} option.
4045 @c man begin OPTIONS dlltool
4047 The command line options have the following meanings:
4051 @item -d @var{filename}
4052 @itemx --input-def @var{filename}
4053 @cindex input .def file
4054 Specifies the name of a @file{.def} file to be read in and processed.
4056 @item -b @var{filename}
4057 @itemx --base-file @var{filename}
4059 Specifies the name of a base file to be read in and processed. The
4060 contents of this file will be added to the relocation section in the
4061 exports file generated by dlltool.
4063 @item -e @var{filename}
4064 @itemx --output-exp @var{filename}
4065 Specifies the name of the export file to be created by dlltool.
4067 @item -z @var{filename}
4068 @itemx --output-def @var{filename}
4069 Specifies the name of the @file{.def} file to be created by dlltool.
4071 @item -l @var{filename}
4072 @itemx --output-lib @var{filename}
4073 Specifies the name of the library file to be created by dlltool.
4075 @item -y @var{filename}
4076 @itemx --output-delaylib @var{filename}
4077 Specifies the name of the delay-import library file to be created by dlltool.
4079 @item --export-all-symbols
4080 Treat all global and weak defined symbols found in the input object
4081 files as symbols to be exported. There is a small list of symbols which
4082 are not exported by default; see the @option{--no-default-excludes}
4083 option. You may add to the list of symbols to not export by using the
4084 @option{--exclude-symbols} option.
4086 @item --no-export-all-symbols
4087 Only export symbols explicitly listed in an input @file{.def} file or in
4088 @samp{.drectve} sections in the input object files. This is the default
4089 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4090 attributes in the source code.
4092 @item --exclude-symbols @var{list}
4093 Do not export the symbols in @var{list}. This is a list of symbol names
4094 separated by comma or colon characters. The symbol names should not
4095 contain a leading underscore. This is only meaningful when
4096 @option{--export-all-symbols} is used.
4098 @item --no-default-excludes
4099 When @option{--export-all-symbols} is used, it will by default avoid
4100 exporting certain special symbols. The current list of symbols to avoid
4101 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4102 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
4103 to go ahead and export these special symbols. This is only meaningful
4104 when @option{--export-all-symbols} is used.
4107 @itemx --as @var{path}
4108 Specifies the path, including the filename, of the assembler to be used
4109 to create the exports file.
4111 @item -f @var{options}
4112 @itemx --as-flags @var{options}
4113 Specifies any specific command line options to be passed to the
4114 assembler when building the exports file. This option will work even if
4115 the @option{-S} option is not used. This option only takes one argument,
4116 and if it occurs more than once on the command line, then later
4117 occurrences will override earlier occurrences. So if it is necessary to
4118 pass multiple options to the assembler they should be enclosed in
4122 @itemx --dll-name @var{name}
4123 Specifies the name to be stored in the @file{.def} file as the name of
4124 the DLL when the @option{-e} option is used. If this option is not
4125 present, then the filename given to the @option{-e} option will be
4126 used as the name of the DLL.
4128 @item -m @var{machine}
4129 @itemx -machine @var{machine}
4130 Specifies the type of machine for which the library file should be
4131 built. @command{dlltool} has a built in default type, depending upon how
4132 it was created, but this option can be used to override that. This is
4133 normally only useful when creating DLLs for an ARM processor, when the
4134 contents of the DLL are actually encode using Thumb instructions.
4137 @itemx --add-indirect
4138 Specifies that when @command{dlltool} is creating the exports file it
4139 should add a section which allows the exported functions to be
4140 referenced without using the import library. Whatever the hell that
4144 @itemx --add-underscore
4145 Specifies that when @command{dlltool} is creating the exports file it
4146 should prepend an underscore to the names of @emph{all} exported symbols.
4148 @item --no-leading-underscore
4149 @item --leading-underscore
4150 Specifies whether standard symbol should be forced to be prefixed, or
4153 @item --add-stdcall-underscore
4154 Specifies that when @command{dlltool} is creating the exports file it
4155 should prepend an underscore to the names of exported @emph{stdcall}
4156 functions. Variable names and non-stdcall function names are not modified.
4157 This option is useful when creating GNU-compatible import libs for third
4158 party DLLs that were built with MS-Windows tools.
4162 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4163 of stdcall functions that will be imported from the DLL. This is
4164 useful when creating an import library for a DLL which exports stdcall
4165 functions but without the usual @samp{@@<number>} symbol name suffix.
4167 This does not change the naming of symbols provided by the import library
4168 to programs linked against it, but only the entries in the import table
4169 (ie the .idata section).
4172 @itemx --add-stdcall-alias
4173 Specifies that when @command{dlltool} is creating the exports file it
4174 should add aliases for stdcall symbols without @samp{@@ <number>}
4175 in addition to the symbols with @samp{@@ <number>}.
4178 @itemx --ext-prefix-alias @var{prefix}
4179 Causes @command{dlltool} to create external aliases for all DLL
4180 imports with the specified prefix. The aliases are created for both
4181 external and import symbols with no leading underscore.
4185 Specifies that when @command{dlltool} is creating the exports and library
4186 files it should omit the @code{.idata4} section. This is for compatibility
4187 with certain operating systems.
4189 @item --use-nul-prefixed-import-tables
4190 Specifies that when @command{dlltool} is creating the exports and library
4191 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4192 element. This emulates old gnu import library generation of
4193 @code{dlltool}. By default this option is turned off.
4197 Specifies that when @command{dlltool} is creating the exports and library
4198 files it should omit the @code{.idata5} section. This is for compatibility
4199 with certain operating systems.
4201 @item -I @var{filename}
4202 @itemx --identify @var{filename}
4203 Specifies that @command{dlltool} should inspect the import library
4204 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4205 of the associated DLL(s). This can be performed in addition to any
4206 other operations indicated by the other options and arguments.
4207 @command{dlltool} fails if the import library does not exist or is not
4208 actually an import library. See also @option{--identify-strict}.
4210 @item --identify-strict
4211 Modifies the behavior of the @option{--identify} option, such
4212 that an error is reported if @var{filename} is associated with
4217 Specifies that @command{dlltool} should mark the objects in the library
4218 file and exports file that it produces as supporting interworking
4219 between ARM and Thumb code.
4223 Makes @command{dlltool} preserve the temporary assembler files it used to
4224 create the exports file. If this option is repeated then dlltool will
4225 also preserve the temporary object files it uses to create the library
4228 @item -t @var{prefix}
4229 @itemx --temp-prefix @var{prefix}
4230 Makes @command{dlltool} use @var{prefix} when constructing the names of
4231 temporary assembler and object files. By default, the temp file prefix
4232 is generated from the pid.
4236 Make dlltool describe what it is doing.
4240 Displays a list of command line options and then exits.
4244 Displays dlltool's version number and then exits.
4251 * def file format:: The format of the dlltool @file{.def} file
4254 @node def file format
4255 @section The format of the @command{dlltool} @file{.def} file
4257 A @file{.def} file contains any number of the following commands:
4261 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4262 The result is going to be named @var{name}@code{.exe}.
4264 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4265 The result is going to be named @var{name}@code{.dll}.
4266 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4267 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4270 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4271 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4272 Declares @var{name1} as an exported symbol from the DLL, with optional
4273 ordinal number @var{integer}, or declares @var{name1} as an alias
4274 (forward) of the function @var{external-name} in the DLL.
4275 If @var{its_name} is specified, this name is used as string in export table.
4277 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4278 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4279 If you want to use LIBRARY as name then you need to quote it.
4281 @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{]} *}
4282 Declares that @var{external-name} or the exported function whose
4283 ordinal number is @var{integer} is to be imported from the file
4284 @var{module-name}. If @var{internal-name} is specified then this is
4285 the name that the imported function will be referred to in the body of
4287 If @var{its_name} is specified, this name is used as string in import table.
4288 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4289 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4290 If you want to use LIBRARY as name then you need to quote it.
4292 @item @code{DESCRIPTION} @var{string}
4293 Puts @var{string} into the output @file{.exp} file in the
4294 @code{.rdata} section.
4296 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4297 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4298 Generates @code{--stack} or @code{--heap}
4299 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4300 section. The linker will see this and act upon it.
4302 @item @code{CODE} @var{attr} @code{+}
4303 @item @code{DATA} @var{attr} @code{+}
4304 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4305 Generates @code{--attr} @var{section-name} @var{attr} in the output
4306 @code{.drectve} section, where @var{attr} is one of @code{READ},
4307 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4308 this and act upon it.
4313 @c man begin SEEALSO dlltool
4314 The Info pages for @file{binutils}.
4321 @cindex ELF file information
4324 @c man title readelf Displays information about ELF files.
4327 @c man begin SYNOPSIS readelf
4328 readelf [@option{-a}|@option{--all}]
4329 [@option{-h}|@option{--file-header}]
4330 [@option{-l}|@option{--program-headers}|@option{--segments}]
4331 [@option{-S}|@option{--section-headers}|@option{--sections}]
4332 [@option{-g}|@option{--section-groups}]
4333 [@option{-t}|@option{--section-details}]
4334 [@option{-e}|@option{--headers}]
4335 [@option{-s}|@option{--syms}|@option{--symbols}]
4336 [@option{--dyn-syms}]
4337 [@option{-n}|@option{--notes}]
4338 [@option{-r}|@option{--relocs}]
4339 [@option{-u}|@option{--unwind}]
4340 [@option{-d}|@option{--dynamic}]
4341 [@option{-V}|@option{--version-info}]
4342 [@option{-A}|@option{--arch-specific}]
4343 [@option{-D}|@option{--use-dynamic}]
4344 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4345 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4346 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4347 [@option{-z}|@option{--decompress}]
4348 [@option{-c}|@option{--archive-index}]
4349 [@option{-w[lLiaprmfFsoRt]}|
4350 @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]]
4351 [@option{--dwarf-depth=@var{n}}]
4352 [@option{--dwarf-start=@var{n}}]
4353 [@option{-I}|@option{--histogram}]
4354 [@option{-v}|@option{--version}]
4355 [@option{-W}|@option{--wide}]
4356 [@option{-H}|@option{--help}]
4357 @var{elffile}@dots{}
4361 @c man begin DESCRIPTION readelf
4363 @command{readelf} displays information about one or more ELF format object
4364 files. The options control what particular information to display.
4366 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4367 64-bit ELF files are supported, as are archives containing ELF files.
4369 This program performs a similar function to @command{objdump} but it
4370 goes into more detail and it exists independently of the @sc{bfd}
4371 library, so if there is a bug in @sc{bfd} then readelf will not be
4376 @c man begin OPTIONS readelf
4378 The long and short forms of options, shown here as alternatives, are
4379 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4385 Equivalent to specifying @option{--file-header},
4386 @option{--program-headers}, @option{--sections}, @option{--symbols},
4387 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4388 @option{--version-info}.
4391 @itemx --file-header
4392 @cindex ELF file header information
4393 Displays the information contained in the ELF header at the start of the
4397 @itemx --program-headers
4399 @cindex ELF program header information
4400 @cindex ELF segment information
4401 Displays the information contained in the file's segment headers, if it
4406 @itemx --section-headers
4407 @cindex ELF section information
4408 Displays the information contained in the file's section headers, if it
4412 @itemx --section-groups
4413 @cindex ELF section group information
4414 Displays the information contained in the file's section groups, if it
4418 @itemx --section-details
4419 @cindex ELF section information
4420 Displays the detailed section information. Implies @option{-S}.
4425 @cindex ELF symbol table information
4426 Displays the entries in symbol table section of the file, if it has one.
4429 @cindex ELF dynamic symbol table information
4430 Displays the entries in dynamic symbol table section of the file, if it
4435 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4440 Displays the contents of the NOTE segments and/or sections, if any.
4444 @cindex ELF reloc information
4445 Displays the contents of the file's relocation section, if it has one.
4449 @cindex unwind information
4450 Displays the contents of the file's unwind section, if it has one. Only
4451 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4452 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4456 @cindex ELF dynamic section information
4457 Displays the contents of the file's dynamic section, if it has one.
4460 @itemx --version-info
4461 @cindex ELF version sections information
4462 Displays the contents of the version sections in the file, it they
4466 @itemx --arch-specific
4467 Displays architecture-specific information in the file, if there
4471 @itemx --use-dynamic
4472 When displaying symbols, this option makes @command{readelf} use the
4473 symbol hash tables in the file's dynamic section, rather than the
4474 symbol table sections.
4476 @item -x <number or name>
4477 @itemx --hex-dump=<number or name>
4478 Displays the contents of the indicated section as a hexadecimal bytes.
4479 A number identifies a particular section by index in the section table;
4480 any other string identifies all sections with that name in the object file.
4482 @item -R <number or name>
4483 @itemx --relocated-dump=<number or name>
4484 Displays the contents of the indicated section as a hexadecimal
4485 bytes. A number identifies a particular section by index in the
4486 section table; any other string identifies all sections with that name
4487 in the object file. The contents of the section will be relocated
4488 before they are displayed.
4490 @item -p <number or name>
4491 @itemx --string-dump=<number or name>
4492 Displays the contents of the indicated section as printable strings.
4493 A number identifies a particular section by index in the section table;
4494 any other string identifies all sections with that name in the object file.
4498 Requests that the section(s) being dumped by @option{x}, @option{R} or
4499 @option{p} options are decompressed before being displayed. If the
4500 section(s) are not compressed then they are displayed as is.
4503 @itemx --archive-index
4504 @cindex Archive file symbol index information
4505 Displays the file symbol index information contained in the header part
4506 of binary archives. Performs the same function as the @option{t}
4507 command to @command{ar}, but without using the BFD library. @xref{ar}.
4509 @item -w[lLiaprmfFsoRt]
4510 @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]
4511 Displays the contents of the debug sections in the file, if any are
4512 present. If one of the optional letters or words follows the switch
4513 then only data found in those specific sections will be dumped.
4515 Note that there is no single letter option to display the content of
4516 trace sections or .gdb_index.
4518 Note: the @option{=decodedline} option will display the interpreted
4519 contents of a .debug_line section whereas the @option{=rawline} option
4520 dumps the contents in a raw format.
4522 Note: the @option{=frames-interp} option will display the interpreted
4523 contents of a .debug_frame section whereas the @option{=frames} option
4524 dumps the contents in a raw format.
4526 Note: the output from the @option{=info} option can also be affected
4527 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4529 @item --dwarf-depth=@var{n}
4530 Limit the dump of the @code{.debug_info} section to @var{n} children.
4531 This is only useful with @option{--debug-dump=info}. The default is
4532 to print all DIEs; the special value 0 for @var{n} will also have this
4535 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4536 levels will not be printed. The range for @var{n} is zero-based.
4538 @item --dwarf-start=@var{n}
4539 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4540 useful with @option{--debug-dump=info}.
4542 If specified, this option will suppress printing of any header
4543 information and all DIEs before the DIE numbered @var{n}. Only
4544 siblings and children of the specified DIE will be printed.
4546 This can be used in conjunction with @option{--dwarf-depth}.
4550 Display a histogram of bucket list lengths when displaying the contents
4551 of the symbol tables.
4555 Display the version number of readelf.
4559 Don't break output lines to fit into 80 columns. By default
4560 @command{readelf} breaks section header and segment listing lines for
4561 64-bit ELF files, so that they fit into 80 columns. This option causes
4562 @command{readelf} to print each section header resp. each segment one a
4563 single line, which is far more readable on terminals wider than 80 columns.
4567 Display the command line options understood by @command{readelf}.
4574 @c man begin SEEALSO readelf
4575 objdump(1), and the Info entries for @file{binutils}.
4582 @cindex Update ELF header
4585 @c man title elfedit Update the ELF header of ELF files.
4588 @c man begin SYNOPSIS elfedit
4589 elfedit [@option{--input-mach=}@var{machine}]
4590 [@option{--input-type=}@var{type}]
4591 [@option{--input-osabi=}@var{osabi}]
4592 @option{--output-mach=}@var{machine}
4593 @option{--output-type=}@var{type}
4594 @option{--output-osabi=}@var{osabi}
4595 [@option{-v}|@option{--version}]
4596 [@option{-h}|@option{--help}]
4597 @var{elffile}@dots{}
4601 @c man begin DESCRIPTION elfedit
4603 @command{elfedit} updates the ELF header of ELF files which have
4604 the matching ELF machine and file types. The options control how and
4605 which fields in the ELF header should be updated.
4607 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4608 64-bit ELF files are supported, as are archives containing ELF files.
4611 @c man begin OPTIONS elfedit
4613 The long and short forms of options, shown here as alternatives, are
4614 equivalent. At least one of the @option{--output-mach},
4615 @option{--output-type} and @option{--output-osabi} options must be given.
4619 @item --input-mach=@var{machine}
4620 Set the matching input ELF machine type to @var{machine}. If
4621 @option{--input-mach} isn't specified, it will match any ELF
4624 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4625 @var{K1OM} and @var{x86-64}.
4627 @item --output-mach=@var{machine}
4628 Change the ELF machine type in the ELF header to @var{machine}. The
4629 supported ELF machine types are the same as @option{--input-mach}.
4631 @item --input-type=@var{type}
4632 Set the matching input ELF file type to @var{type}. If
4633 @option{--input-type} isn't specified, it will match any ELF file types.
4635 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4637 @item --output-type=@var{type}
4638 Change the ELF file type in the ELF header to @var{type}. The
4639 supported ELF types are the same as @option{--input-type}.
4641 @item --input-osabi=@var{osabi}
4642 Set the matching input ELF file OSABI to @var{osabi}. If
4643 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4645 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4646 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4647 @var{Solaris}, @var{AIX}, @var{Irix},
4648 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4649 @var{NSK}, @var{AROS} and @var{FenixOS}.
4651 @item --output-osabi=@var{osabi}
4652 Change the ELF OSABI in the ELF header to @var{osabi}. The
4653 supported ELF OSABI are the same as @option{--input-osabi}.
4657 Display the version number of @command{elfedit}.
4661 Display the command line options understood by @command{elfedit}.
4668 @c man begin SEEALSO elfedit
4669 readelf(1), and the Info entries for @file{binutils}.
4673 @node Common Options
4674 @chapter Common Options
4676 The following command-line options are supported by all of the
4677 programs described in this manual.
4679 @c man begin OPTIONS
4681 @include at-file.texi
4685 Display the command-line options supported by the program.
4688 Display the version number of the program.
4690 @c man begin OPTIONS
4694 @node Selecting the Target System
4695 @chapter Selecting the Target System
4697 You can specify two aspects of the target system to the @sc{gnu}
4698 binary file utilities, each in several ways:
4708 In the following summaries, the lists of ways to specify values are in
4709 order of decreasing precedence. The ways listed first override those
4712 The commands to list valid values only list the values for which the
4713 programs you are running were configured. If they were configured with
4714 @option{--enable-targets=all}, the commands list most of the available
4715 values, but a few are left out; not all targets can be configured in at
4716 once because some of them can only be configured @dfn{native} (on hosts
4717 with the same type as the target system).
4720 * Target Selection::
4721 * Architecture Selection::
4724 @node Target Selection
4725 @section Target Selection
4727 A @dfn{target} is an object file format. A given target may be
4728 supported for multiple architectures (@pxref{Architecture Selection}).
4729 A target selection may also have variations for different operating
4730 systems or architectures.
4732 The command to list valid target values is @samp{objdump -i}
4733 (the first column of output contains the relevant information).
4735 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4736 @samp{a.out-sunos-big}.
4738 You can also specify a target using a configuration triplet. This is
4739 the same sort of name that is passed to @file{configure} to specify a
4740 target. When you use a configuration triplet as an argument, it must be
4741 fully canonicalized. You can see the canonical version of a triplet by
4742 running the shell script @file{config.sub} which is included with the
4745 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4746 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4748 @subheading @command{objdump} Target
4754 command line option: @option{-b} or @option{--target}
4757 environment variable @code{GNUTARGET}
4760 deduced from the input file
4763 @subheading @command{objcopy} and @command{strip} Input Target
4769 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4772 environment variable @code{GNUTARGET}
4775 deduced from the input file
4778 @subheading @command{objcopy} and @command{strip} Output Target
4784 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4787 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4790 environment variable @code{GNUTARGET}
4793 deduced from the input file
4796 @subheading @command{nm}, @command{size}, and @command{strings} Target
4802 command line option: @option{--target}
4805 environment variable @code{GNUTARGET}
4808 deduced from the input file
4811 @node Architecture Selection
4812 @section Architecture Selection
4814 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4815 to run. Its name may contain a colon, separating the name of the
4816 processor family from the name of the particular @sc{cpu}.
4818 The command to list valid architecture values is @samp{objdump -i} (the
4819 second column contains the relevant information).
4821 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4823 @subheading @command{objdump} Architecture
4829 command line option: @option{-m} or @option{--architecture}
4832 deduced from the input file
4835 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4841 deduced from the input file
4844 @node Reporting Bugs
4845 @chapter Reporting Bugs
4847 @cindex reporting bugs
4849 Your bug reports play an essential role in making the binary utilities
4852 Reporting a bug may help you by bringing a solution to your problem, or
4853 it may not. But in any case the principal function of a bug report is
4854 to help the entire community by making the next version of the binary
4855 utilities work better. Bug reports are your contribution to their
4858 In order for a bug report to serve its purpose, you must include the
4859 information that enables us to fix the bug.
4862 * Bug Criteria:: Have you found a bug?
4863 * Bug Reporting:: How to report bugs
4867 @section Have You Found a Bug?
4868 @cindex bug criteria
4870 If you are not sure whether you have found a bug, here are some guidelines:
4873 @cindex fatal signal
4876 If a binary utility gets a fatal signal, for any input whatever, that is
4877 a bug. Reliable utilities never crash.
4879 @cindex error on valid input
4881 If a binary utility produces an error message for valid input, that is a
4885 If you are an experienced user of binary utilities, your suggestions for
4886 improvement are welcome in any case.
4890 @section How to Report Bugs
4892 @cindex bugs, reporting
4894 A number of companies and individuals offer support for @sc{gnu}
4895 products. If you obtained the binary utilities from a support
4896 organization, we recommend you contact that organization first.
4898 You can find contact information for many support companies and
4899 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4903 In any event, we also recommend that you send bug reports for the binary
4904 utilities to @value{BUGURL}.
4907 The fundamental principle of reporting bugs usefully is this:
4908 @strong{report all the facts}. If you are not sure whether to state a
4909 fact or leave it out, state it!
4911 Often people omit facts because they think they know what causes the
4912 problem and assume that some details do not matter. Thus, you might
4913 assume that the name of a file you use in an example does not matter.
4914 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4915 a stray memory reference which happens to fetch from the location where
4916 that pathname is stored in memory; perhaps, if the pathname were
4917 different, the contents of that location would fool the utility into
4918 doing the right thing despite the bug. Play it safe and give a
4919 specific, complete example. That is the easiest thing for you to do,
4920 and the most helpful.
4922 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4923 it is new to us. Therefore, always write your bug reports on the assumption
4924 that the bug has not been reported previously.
4926 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4927 bell?'' This cannot help us fix a bug, so it is basically useless. We
4928 respond by asking for enough details to enable us to investigate.
4929 You might as well expedite matters by sending them to begin with.
4931 To enable us to fix the bug, you should include all these things:
4935 The version of the utility. Each utility announces it if you start it
4936 with the @option{--version} argument.
4938 Without this, we will not know whether there is any point in looking for
4939 the bug in the current version of the binary utilities.
4942 Any patches you may have applied to the source, including any patches
4943 made to the @code{BFD} library.
4946 The type of machine you are using, and the operating system name and
4950 What compiler (and its version) was used to compile the utilities---e.g.
4954 The command arguments you gave the utility to observe the bug. To
4955 guarantee you will not omit something important, list them all. A copy
4956 of the Makefile (or the output from make) is sufficient.
4958 If we were to try to guess the arguments, we would probably guess wrong
4959 and then we might not encounter the bug.
4962 A complete input file, or set of input files, that will reproduce the
4963 bug. If the utility is reading an object file or files, then it is
4964 generally most helpful to send the actual object files.
4966 If the source files were produced exclusively using @sc{gnu} programs
4967 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4968 may be OK to send the source files rather than the object files. In
4969 this case, be sure to say exactly what version of @command{gcc}, or
4970 whatever, was used to produce the object files. Also say how
4971 @command{gcc}, or whatever, was configured.
4974 A description of what behavior you observe that you believe is
4975 incorrect. For example, ``It gets a fatal signal.''
4977 Of course, if the bug is that the utility gets a fatal signal, then we
4978 will certainly notice it. But if the bug is incorrect output, we might
4979 not notice unless it is glaringly wrong. You might as well not give us
4980 a chance to make a mistake.
4982 Even if the problem you experience is a fatal signal, you should still
4983 say so explicitly. Suppose something strange is going on, such as your
4984 copy of the utility is out of sync, or you have encountered a bug in
4985 the C library on your system. (This has happened!) Your copy might
4986 crash and ours would not. If you told us to expect a crash, then when
4987 ours fails to crash, we would know that the bug was not happening for
4988 us. If you had not told us to expect a crash, then we would not be able
4989 to draw any conclusion from our observations.
4992 If you wish to suggest changes to the source, send us context diffs, as
4993 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4994 option. Always send diffs from the old file to the new file. If you
4995 wish to discuss something in the @command{ld} source, refer to it by
4996 context, not by line number.
4998 The line numbers in our development sources will not match those in your
4999 sources. Your line numbers would convey no useful information to us.
5002 Here are some things that are not necessary:
5006 A description of the envelope of the bug.
5008 Often people who encounter a bug spend a lot of time investigating
5009 which changes to the input file will make the bug go away and which
5010 changes will not affect it.
5012 This is often time consuming and not very useful, because the way we
5013 will find the bug is by running a single example under the debugger
5014 with breakpoints, not by pure deduction from a series of examples.
5015 We recommend that you save your time for something else.
5017 Of course, if you can find a simpler example to report @emph{instead}
5018 of the original one, that is a convenience for us. Errors in the
5019 output will be easier to spot, running under the debugger will take
5020 less time, and so on.
5022 However, simplification is not vital; if you do not want to do this,
5023 report the bug anyway and send us the entire test case you used.
5026 A patch for the bug.
5028 A patch for the bug does help us if it is a good one. But do not omit
5029 the necessary information, such as the test case, on the assumption that
5030 a patch is all we need. We might see problems with your patch and decide
5031 to fix the problem another way, or we might not understand it at all.
5033 Sometimes with programs as complicated as the binary utilities it is
5034 very hard to construct an example that will make the program follow a
5035 certain path through the code. If you do not send us the example, we
5036 will not be able to construct one, so we will not be able to verify that
5039 And if we cannot understand what bug you are trying to fix, or why your
5040 patch should be an improvement, we will not install it. A test case will
5041 help us to understand.
5044 A guess about what the bug is or what it depends on.
5046 Such guesses are usually wrong. Even we cannot guess right about such
5047 things without first using the debugger to find the facts.
5050 @node GNU Free Documentation License
5051 @appendix GNU Free Documentation License
5055 @node Binutils Index
5056 @unnumbered Binutils Index