1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2013 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.3
17 or any later version published by the Free Software Foundation;
18 with no Invariant Sections, with no Front-Cover Texts, and with no
19 Back-Cover Texts. A copy of the license is included in the
20 section entitled ``GNU Free Documentation License''.
25 @dircategory Software development
27 * Binutils: (binutils). The GNU binary utilities.
30 @dircategory Individual utilities
32 * addr2line: (binutils)addr2line. Convert addresses to file and line.
33 * ar: (binutils)ar. Create, modify, and extract from archives.
34 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
35 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
36 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
37 * nlmconv: (binutils)nlmconv. Converts object code into an NLM.
38 * nm: (binutils)nm. List symbols from object files.
39 * objcopy: (binutils)objcopy. Copy and translate object files.
40 * objdump: (binutils)objdump. Display information from object files.
41 * ranlib: (binutils)ranlib. Generate index to archive contents.
42 * readelf: (binutils)readelf. Display the contents of ELF format files.
43 * size: (binutils)size. List section sizes and total size.
44 * strings: (binutils)strings. List printable strings from files.
45 * strip: (binutils)strip. Discard symbols.
46 * elfedit: (binutils)elfedit. Update the ELF header of ELF files.
47 * windmc: (binutils)windmc. Generator for Windows message resources.
48 * windres: (binutils)windres. Manipulate Windows resources.
52 @title The @sc{gnu} Binary Utilities
53 @ifset VERSION_PACKAGE
54 @subtitle @value{VERSION_PACKAGE}
56 @subtitle Version @value{VERSION}
58 @subtitle @value{UPDATED}
59 @author Roland H. Pesch
60 @author Jeffrey M. Osier
61 @author Cygnus Support
65 {\parskip=0pt \hfill Cygnus Support\par \hfill
66 Texinfo \texinfoversion\par }
69 @vskip 0pt plus 1filll
78 This brief manual contains documentation for the @sc{gnu} binary
80 @ifset VERSION_PACKAGE
81 @value{VERSION_PACKAGE}
83 version @value{VERSION}:
88 Create, modify, and extract from archives
91 List symbols from object files
94 Copy and translate object files
97 Display information from object files
100 Generate index to archive contents
103 Display the contents of ELF format files.
106 List file section sizes and total size
109 List printable strings from files
115 Update the ELF header of ELF files.
118 Demangle encoded C++ symbols (on MS-DOS, this program is named
122 Convert addresses into file names and line numbers
125 Convert object code into a Netware Loadable Module
128 Manipulate Windows resources
131 Generator for Windows message resources
134 Create the files needed to build and use Dynamic Link Libraries
138 This document is distributed under the terms of the GNU Free
139 Documentation License version 1.3. A copy of the license is included
140 in the section entitled ``GNU Free Documentation License''.
143 * ar:: Create, modify, and extract from archives
144 * nm:: List symbols from object files
145 * objcopy:: Copy and translate object files
146 * objdump:: Display information from object files
147 * ranlib:: Generate index to archive contents
148 * size:: List section sizes and total size
149 * strings:: List printable strings from files
150 * strip:: Discard symbols
151 * c++filt:: Filter to demangle encoded C++ symbols
152 * cxxfilt: c++filt. MS-DOS name for c++filt
153 * addr2line:: Convert addresses to file and line
154 * nlmconv:: Converts object code into an NLM
155 * windmc:: Generator for Windows message resources
156 * windres:: Manipulate Windows resources
157 * dlltool:: Create files needed to build and use DLLs
158 * readelf:: Display the contents of ELF format files
159 * elfedit:: Update the ELF header of ELF files
160 * Common Options:: Command-line options for all utilities
161 * Selecting the Target System:: How these utilities determine the target
162 * Reporting Bugs:: Reporting Bugs
163 * GNU Free Documentation License:: GNU Free Documentation License
164 * Binutils Index:: Binutils Index
172 @cindex collections of files
174 @c man title ar create, modify, and extract from archives
177 ar [@option{--plugin} @var{name}] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] [@option{--target} @var{bfdname}] @var{archive} [@var{member}@dots{}]
178 ar -M [ <mri-script ]
181 @c man begin DESCRIPTION ar
183 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
184 archives. An @dfn{archive} is a single file holding a collection of
185 other files in a structure that makes it possible to retrieve
186 the original individual files (called @dfn{members} of the archive).
188 The original files' contents, mode (permissions), timestamp, owner, and
189 group are preserved in the archive, and can be restored on
193 @sc{gnu} @command{ar} can maintain archives whose members have names of any
194 length; however, depending on how @command{ar} is configured on your
195 system, a limit on member-name length may be imposed for compatibility
196 with archive formats maintained with other tools. If it exists, the
197 limit is often 15 characters (typical of formats related to a.out) or 16
198 characters (typical of formats related to coff).
201 @command{ar} is considered a binary utility because archives of this sort
202 are most often used as @dfn{libraries} holding commonly needed
206 @command{ar} creates an index to the symbols defined in relocatable
207 object modules in the archive when you specify the modifier @samp{s}.
208 Once created, this index is updated in the archive whenever @command{ar}
209 makes a change to its contents (save for the @samp{q} update operation).
210 An archive with such an index speeds up linking to the library, and
211 allows routines in the library to call each other without regard to
212 their placement in the archive.
214 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
215 table. If an archive lacks the table, another form of @command{ar} called
216 @command{ranlib} can be used to add just the table.
218 @cindex thin archives
219 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
220 which contains a symbol index and references to the original copies
221 of the member files of the archive. This is useful for building
222 libraries for use within a local build tree, where the relocatable
223 objects are expected to remain available, and copying the contents of
224 each object would only waste time and space.
226 An archive can either be @emph{thin} or it can be normal. It cannot
227 be both at the same time. Once an archive is created its format
228 cannot be changed without first deleting it and then creating a new
229 archive in its place.
231 Thin archives are also @emph{flattened}, so that adding one thin
232 archive to another thin archive does not nest it, as would happen with
233 a normal archive. Instead the elements of the first archive are added
234 individually to the second archive.
236 The paths to the elements of the archive are stored relative to the
239 @cindex compatibility, @command{ar}
240 @cindex @command{ar} compatibility
241 @sc{gnu} @command{ar} is designed to be compatible with two different
242 facilities. You can control its activity using command-line options,
243 like the different varieties of @command{ar} on Unix systems; or, if you
244 specify the single command-line option @option{-M}, you can control it
245 with a script supplied via standard input, like the MRI ``librarian''
251 * ar cmdline:: Controlling @command{ar} on the command line
252 * ar scripts:: Controlling @command{ar} with a script
257 @section Controlling @command{ar} on the Command Line
260 @c man begin SYNOPSIS ar
261 ar [@option{--plugin} @var{name}] [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] [@option{--target} @var{bfdname}] @var{archive} [@var{member}@dots{}]
265 @cindex Unix compatibility, @command{ar}
266 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
267 arguments to execute: one keyletter specifying the @emph{operation}
268 (optionally accompanied by other keyletters specifying
269 @emph{modifiers}), and the archive name to act on.
271 Most operations can also accept further @var{member} arguments,
272 specifying particular files to operate on.
274 @c man begin OPTIONS ar
276 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
277 flags @var{mod} in any order, within the first command-line argument.
279 If you wish, you may begin the first command-line argument with a
282 @cindex operations on archive
283 The @var{p} keyletter specifies what operation to execute; it may be
284 any of the following, but you must specify only one of them:
288 @cindex deleting from archive
289 @emph{Delete} modules from the archive. Specify the names of modules to
290 be deleted as @var{member}@dots{}; the archive is untouched if you
291 specify no files to delete.
293 If you specify the @samp{v} modifier, @command{ar} lists each module
297 @cindex moving in archive
298 Use this operation to @emph{move} members in an archive.
300 The ordering of members in an archive can make a difference in how
301 programs are linked using the library, if a symbol is defined in more
304 If no modifiers are used with @code{m}, any members you name in the
305 @var{member} arguments are moved to the @emph{end} of the archive;
306 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
307 specified place instead.
310 @cindex printing from archive
311 @emph{Print} the specified members of the archive, to the standard
312 output file. If the @samp{v} modifier is specified, show the member
313 name before copying its contents to standard output.
315 If you specify no @var{member} arguments, all the files in the archive are
319 @cindex quick append to archive
320 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
321 @var{archive}, without checking for replacement.
323 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
324 operation; new members are always placed at the end of the archive.
326 The modifier @samp{v} makes @command{ar} list each file as it is appended.
328 Since the point of this operation is speed, the archive's symbol table
329 index is not updated, even if it already existed; you can use @samp{ar s} or
330 @command{ranlib} explicitly to update the symbol table index.
332 However, too many different systems assume quick append rebuilds the
333 index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
336 @cindex replacement in archive
337 Insert the files @var{member}@dots{} into @var{archive} (with
338 @emph{replacement}). This operation differs from @samp{q} in that any
339 previously existing members are deleted if their names match those being
342 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
343 displays an error message, and leaves undisturbed any existing members
344 of the archive matching that name.
346 By default, new members are added at the end of the file; but you may
347 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
348 placement relative to some existing member.
350 The modifier @samp{v} used with this operation elicits a line of
351 output for each file inserted, along with one of the letters @samp{a} or
352 @samp{r} to indicate whether the file was appended (no old member
353 deleted) or replaced.
357 Add an index to the archive, or update it if it already exists. Note
358 this command is an exception to the rule that there can only be one
359 command letter, as it is possible to use it as either a command or a
360 modifier. In either case it does the same thing.
363 @cindex contents of archive
364 Display a @emph{table} listing the contents of @var{archive}, or those
365 of the files listed in @var{member}@dots{} that are present in the
366 archive. Normally only the member name is shown; if you also want to
367 see the modes (permissions), timestamp, owner, group, and size, you can
368 request that by also specifying the @samp{v} modifier.
370 If you do not specify a @var{member}, all files in the archive
373 @cindex repeated names in archive
374 @cindex name duplication in archive
375 If there is more than one file with the same name (say, @samp{fie}) in
376 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
377 first instance; to see them all, you must ask for a complete
378 listing---in our example, @samp{ar t b.a}.
379 @c WRS only; per Gumby, this is implementation-dependent, and in a more
380 @c recent case in fact works the other way.
383 @cindex extract from archive
384 @emph{Extract} members (named @var{member}) from the archive. You can
385 use the @samp{v} modifier with this operation, to request that
386 @command{ar} list each name as it extracts it.
388 If you do not specify a @var{member}, all files in the archive
391 Files cannot be extracted from a thin archive.
394 Displays the list of command line options supported by @command{ar}
398 Displays the version information of @command{ar} and then exits.
402 A number of modifiers (@var{mod}) may immediately follow the @var{p}
403 keyletter, to specify variations on an operation's behavior:
407 @cindex relative placement in archive
408 Add new files @emph{after} an existing member of the
409 archive. If you use the modifier @samp{a}, the name of an existing archive
410 member must be present as the @var{relpos} argument, before the
411 @var{archive} specification.
414 Add new files @emph{before} an existing member of the
415 archive. If you use the modifier @samp{b}, the name of an existing archive
416 member must be present as the @var{relpos} argument, before the
417 @var{archive} specification. (same as @samp{i}).
420 @cindex creating archives
421 @emph{Create} the archive. The specified @var{archive} is always
422 created if it did not exist, when you request an update. But a warning is
423 issued unless you specify in advance that you expect to create it, by
427 @cindex deterministic archives
428 @kindex --enable-deterministic-archives
429 Operate in @emph{deterministic} mode. When adding files and the archive
430 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
431 for all files. When this option is used, if @command{ar} is used with
432 identical options and identical input files, multiple runs will create
433 identical output files regardless of the input files' owners, groups,
434 file modes, or modification times.
436 If @file{binutils} was configured with
437 @option{--enable-deterministic-archives}, then this mode is on by default.
438 It can be disabled with the @samp{U} modifier, below.
441 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
442 names of any length. This will cause it to create archives which are
443 not compatible with the native @command{ar} program on some systems. If
444 this is a concern, the @samp{f} modifier may be used to truncate file
445 names when putting them in the archive.
448 Insert new files @emph{before} an existing member of the
449 archive. If you use the modifier @samp{i}, the name of an existing archive
450 member must be present as the @var{relpos} argument, before the
451 @var{archive} specification. (same as @samp{b}).
454 This modifier is accepted but not used.
455 @c whaffor ar l modifier??? presumably compat; with
456 @c what???---doc@@cygnus.com, 25jan91
459 Uses the @var{count} parameter. This is used if there are multiple
460 entries in the archive with the same name. Extract or delete instance
461 @var{count} of the given name from the archive.
464 @cindex dates in archive
465 Preserve the @emph{original} dates of members when extracting them. If
466 you do not specify this modifier, files extracted from the archive
467 are stamped with the time of extraction.
470 Use the full path name when matching names in the archive. @sc{gnu}
471 @command{ar} can not create an archive with a full path name (such archives
472 are not POSIX complaint), but other archive creators can. This option
473 will cause @sc{gnu} @command{ar} to match file names using a complete path
474 name, which can be convenient when extracting a single file from an
475 archive created by another tool.
478 @cindex writing archive index
479 Write an object-file index into the archive, or update an existing one,
480 even if no other change is made to the archive. You may use this modifier
481 flag either with any operation, or alone. Running @samp{ar s} on an
482 archive is equivalent to running @samp{ranlib} on it.
485 @cindex not writing archive index
486 Do not generate an archive symbol table. This can speed up building a
487 large library in several steps. The resulting archive can not be used
488 with the linker. In order to build a symbol table, you must omit the
489 @samp{S} modifier on the last execution of @samp{ar}, or you must run
490 @samp{ranlib} on the archive.
493 @cindex creating thin archive
494 Make the specified @var{archive} a @emph{thin} archive. If it already
495 exists and is a regular archive, the existing members must be present
496 in the same directory as @var{archive}.
499 @cindex updating an archive
500 Normally, @samp{ar r}@dots{} inserts all files
501 listed into the archive. If you would like to insert @emph{only} those
502 of the files you list that are newer than existing members of the same
503 names, use this modifier. The @samp{u} modifier is allowed only for the
504 operation @samp{r} (replace). In particular, the combination @samp{qu} is
505 not allowed, since checking the timestamps would lose any speed
506 advantage from the operation @samp{q}.
509 @cindex deterministic archives
510 @kindex --enable-deterministic-archives
511 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
512 of the @samp{D} modifier, above: added files and the archive index will
513 get their actual UID, GID, timestamp, and file mode values.
515 This is the default unless @file{binutils} was configured with
516 @option{--enable-deterministic-archives}.
519 This modifier requests the @emph{verbose} version of an operation. Many
520 operations display additional information, such as filenames processed,
521 when the modifier @samp{v} is appended.
524 This modifier shows the version number of @command{ar}.
527 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
528 compatibility with AIX. The behaviour produced by this option is the
529 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
530 @samp{-X} options; in particular, it does not support @option{-X32}
531 which is the default for AIX @command{ar}.
533 The optional command line switch @option{--plugin} @var{name} causes
534 @command{ar} to load the plugin called @var{name} which adds support
535 for more file formats. This option is only available if the toolchain
536 has been built with plugin support enabled.
538 The optional command line switch @option{--target} @var{bfdname}
539 specifies that the archive members are in an object code format
540 different from your system's default format. See
541 @xref{Target Selection}, for more information.
546 @c man begin SEEALSO ar
547 nm(1), ranlib(1), and the Info entries for @file{binutils}.
552 @section Controlling @command{ar} with a Script
555 ar -M [ <@var{script} ]
558 @cindex MRI compatibility, @command{ar}
559 @cindex scripts, @command{ar}
560 If you use the single command-line option @samp{-M} with @command{ar}, you
561 can control its operation with a rudimentary command language. This
562 form of @command{ar} operates interactively if standard input is coming
563 directly from a terminal. During interactive use, @command{ar} prompts for
564 input (the prompt is @samp{AR >}), and continues executing even after
565 errors. If you redirect standard input to a script file, no prompts are
566 issued, and @command{ar} abandons execution (with a nonzero exit code)
569 The @command{ar} command language is @emph{not} designed to be equivalent
570 to the command-line options; in fact, it provides somewhat less control
571 over archives. The only purpose of the command language is to ease the
572 transition to @sc{gnu} @command{ar} for developers who already have scripts
573 written for the MRI ``librarian'' program.
575 The syntax for the @command{ar} command language is straightforward:
578 commands are recognized in upper or lower case; for example, @code{LIST}
579 is the same as @code{list}. In the following descriptions, commands are
580 shown in upper case for clarity.
583 a single command may appear on each line; it is the first word on the
587 empty lines are allowed, and have no effect.
590 comments are allowed; text after either of the characters @samp{*}
591 or @samp{;} is ignored.
594 Whenever you use a list of names as part of the argument to an @command{ar}
595 command, you can separate the individual names with either commas or
596 blanks. Commas are shown in the explanations below, for clarity.
599 @samp{+} is used as a line continuation character; if @samp{+} appears
600 at the end of a line, the text on the following line is considered part
601 of the current command.
604 Here are the commands you can use in @command{ar} scripts, or when using
605 @command{ar} interactively. Three of them have special significance:
607 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
608 a temporary file required for most of the other commands.
610 @code{SAVE} commits the changes so far specified by the script. Prior
611 to @code{SAVE}, commands affect only the temporary copy of the current
615 @item ADDLIB @var{archive}
616 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
617 Add all the contents of @var{archive} (or, if specified, each named
618 @var{module} from @var{archive}) to the current archive.
620 Requires prior use of @code{OPEN} or @code{CREATE}.
622 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
623 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
624 @c else like "ar q..."
625 Add each named @var{member} as a module in the current archive.
627 Requires prior use of @code{OPEN} or @code{CREATE}.
630 Discard the contents of the current archive, canceling the effect of
631 any operations since the last @code{SAVE}. May be executed (with no
632 effect) even if no current archive is specified.
634 @item CREATE @var{archive}
635 Creates an archive, and makes it the current archive (required for many
636 other commands). The new archive is created with a temporary name; it
637 is not actually saved as @var{archive} until you use @code{SAVE}.
638 You can overwrite existing archives; similarly, the contents of any
639 existing file named @var{archive} will not be destroyed until @code{SAVE}.
641 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
642 Delete each listed @var{module} from the current archive; equivalent to
643 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
645 Requires prior use of @code{OPEN} or @code{CREATE}.
647 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
648 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
649 List each named @var{module} present in @var{archive}. The separate
650 command @code{VERBOSE} specifies the form of the output: when verbose
651 output is off, output is like that of @samp{ar -t @var{archive}
652 @var{module}@dots{}}. When verbose output is on, the listing is like
653 @samp{ar -tv @var{archive} @var{module}@dots{}}.
655 Output normally goes to the standard output stream; however, if you
656 specify @var{outputfile} as a final argument, @command{ar} directs the
660 Exit from @command{ar}, with a @code{0} exit code to indicate successful
661 completion. This command does not save the output file; if you have
662 changed the current archive since the last @code{SAVE} command, those
665 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
666 Extract each named @var{module} from the current archive, writing them
667 into the current directory as separate files. Equivalent to @samp{ar -x
668 @var{archive} @var{module}@dots{}}.
670 Requires prior use of @code{OPEN} or @code{CREATE}.
673 @c FIXME Tokens but no commands???
680 Display full contents of the current archive, in ``verbose'' style
681 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
682 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
683 enhancement, rather than present for MRI compatibility.)
685 Requires prior use of @code{OPEN} or @code{CREATE}.
687 @item OPEN @var{archive}
688 Opens an existing archive for use as the current archive (required for
689 many other commands). Any changes as the result of subsequent commands
690 will not actually affect @var{archive} until you next use @code{SAVE}.
692 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
693 In the current archive, replace each existing @var{module} (named in
694 the @code{REPLACE} arguments) from files in the current working directory.
695 To execute this command without errors, both the file, and the module in
696 the current archive, must exist.
698 Requires prior use of @code{OPEN} or @code{CREATE}.
701 Toggle an internal flag governing the output from @code{DIRECTORY}.
702 When the flag is on, @code{DIRECTORY} output matches output from
703 @samp{ar -tv }@dots{}.
706 Commit your changes to the current archive, and actually save it as a
707 file with the name specified in the last @code{CREATE} or @code{OPEN}
710 Requires prior use of @code{OPEN} or @code{CREATE}.
719 The @sc{gnu} linker @command{ld} is now described in a separate manual.
720 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
728 @c man title nm list symbols from object files
731 @c man begin SYNOPSIS nm
732 nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
733 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
734 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
735 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
736 [@option{-l}|@option{--line-numbers}] [@option{-n}|@option{-v}|@option{--numeric-sort}]
737 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
738 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
739 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
740 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
741 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
742 [@option{--plugin} @var{name}] [@option{--size-sort}] [@option{--special-syms}]
743 [@option{--synthetic}] [@option{--target=}@var{bfdname}]
744 [@var{objfile}@dots{}]
748 @c man begin DESCRIPTION nm
749 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
750 If no object files are listed as arguments, @command{nm} assumes the file
753 For each symbol, @command{nm} shows:
757 The symbol value, in the radix selected by options (see below), or
758 hexadecimal by default.
761 The symbol type. At least the following types are used; others are, as
762 well, depending on the object file format. If lowercase, the symbol is
763 usually local; if uppercase, the symbol is global (external). There
764 are however a few lowercase symbols that are shown for special global
765 symbols (@code{u}, @code{v} and @code{w}).
767 @c Some more detail on exactly what these symbol types are used for
771 The symbol's value is absolute, and will not be changed by further
776 The symbol is in the uninitialized data section (known as BSS).
779 The symbol is common. Common symbols are uninitialized data. When
780 linking, multiple common symbols may appear with the same name. If the
781 symbol is defined anywhere, the common symbols are treated as undefined
784 For more details on common symbols, see the discussion of
785 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
790 The symbol is in the initialized data section.
794 The symbol is in an initialized data section for small objects. Some
795 object file formats permit more efficient access to small data objects,
796 such as a global int variable as opposed to a large global array.
799 For PE format files this indicates that the symbol is in a section
800 specific to the implementation of DLLs. For ELF format files this
801 indicates that the symbol is an indirect function. This is a GNU
802 extension to the standard set of ELF symbol types. It indicates a
803 symbol which if referenced by a relocation does not evaluate to its
804 address, but instead must be invoked at runtime. The runtime
805 execution will then return the value to be used in the relocation.
808 The symbol is a debugging symbol.
811 The symbols is in a stack unwind section.
815 The symbol is in a read only data section.
819 The symbol is in an uninitialized data section for small objects.
823 The symbol is in the text (code) section.
826 The symbol is undefined.
829 The symbol is a unique global symbol. This is a GNU extension to the
830 standard set of ELF symbol bindings. For such a symbol the dynamic linker
831 will make sure that in the entire process there is just one symbol with
832 this name and type in use.
836 The symbol is a weak object. When a weak defined symbol is linked with
837 a normal defined symbol, the normal defined symbol is used with no error.
838 When a weak undefined symbol is linked and the symbol is not defined,
839 the value of the weak symbol becomes zero with no error. On some
840 systems, uppercase indicates that a default value has been specified.
844 The symbol is a weak symbol that has not been specifically tagged as a
845 weak object symbol. When a weak defined symbol is linked with a normal
846 defined symbol, the normal defined symbol is used with no error.
847 When a weak undefined symbol is linked and the symbol is not defined,
848 the value of the symbol is determined in a system-specific manner without
849 error. On some systems, uppercase indicates that a default value has been
853 The symbol is a stabs symbol in an a.out object file. In this case, the
854 next values printed are the stabs other field, the stabs desc field, and
855 the stab type. Stabs symbols are used to hold debugging information.
858 The symbol type is unknown, or object file format specific.
867 @c man begin OPTIONS nm
868 The long and short forms of options, shown here as alternatives, are
874 @itemx --print-file-name
875 @cindex input file name
877 @cindex source file name
878 Precede each symbol by the name of the input file (or archive member)
879 in which it was found, rather than identifying the input file once only,
880 before all of its symbols.
884 @cindex debugging symbols
885 Display all symbols, even debugger-only symbols; normally these are not
889 @cindex @command{nm} format
890 @cindex @command{nm} compatibility
891 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
894 @itemx --demangle[=@var{style}]
895 @cindex demangling in nm
896 Decode (@dfn{demangle}) low-level symbol names into user-level names.
897 Besides removing any initial underscore prepended by the system, this
898 makes C++ function names readable. Different compilers have different
899 mangling styles. The optional demangling style argument can be used to
900 choose an appropriate demangling style for your compiler. @xref{c++filt},
901 for more information on demangling.
904 Do not demangle low-level symbol names. This is the default.
908 @cindex dynamic symbols
909 Display the dynamic symbols rather than the normal symbols. This is
910 only meaningful for dynamic objects, such as certain types of shared
913 @item -f @var{format}
914 @itemx --format=@var{format}
915 @cindex @command{nm} format
916 @cindex @command{nm} compatibility
917 Use the output format @var{format}, which can be @code{bsd},
918 @code{sysv}, or @code{posix}. The default is @code{bsd}.
919 Only the first character of @var{format} is significant; it can be
920 either upper or lower case.
924 @cindex external symbols
925 Display only external symbols.
929 Show a summary of the options to @command{nm} and exit.
932 @itemx --line-numbers
933 @cindex symbol line numbers
934 For each symbol, use debugging information to try to find a filename and
935 line number. For a defined symbol, look for the line number of the
936 address of the symbol. For an undefined symbol, look for the line
937 number of a relocation entry which refers to the symbol. If line number
938 information can be found, print it after the other symbol information.
942 @itemx --numeric-sort
943 Sort symbols numerically by their addresses, rather than alphabetically
948 @cindex sorting symbols
949 Do not bother to sort the symbols in any order; print them in the order
954 Use the POSIX.2 standard output format instead of the default format.
955 Equivalent to @samp{-f posix}.
958 @itemx --reverse-sort
959 Reverse the order of the sort (whether numeric or alphabetic); let the
964 Print both value and size of defined symbols for the @code{bsd} output style.
965 This option has no effect for object formats that do not record symbol
966 sizes, unless @samp{--size-sort} is also used in which case a
967 calculated size is displayed.
971 @cindex symbol index, listing
972 When listing symbols from archive members, include the index: a mapping
973 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
974 contain definitions for which names.
977 @itemx --radix=@var{radix}
978 Use @var{radix} as the radix for printing the symbol values. It must be
979 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
982 @itemx --undefined-only
983 @cindex external symbols
984 @cindex undefined symbols
985 Display only undefined symbols (those external to each object file).
989 Show the version number of @command{nm} and exit.
992 This option is ignored for compatibility with the AIX version of
993 @command{nm}. It takes one parameter which must be the string
994 @option{32_64}. The default mode of AIX @command{nm} corresponds
995 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
998 @cindex external symbols
999 @cindex undefined symbols
1000 Display only defined symbols for each object file.
1002 @item --plugin @var{name}
1004 Load the plugin called @var{name} to add support for extra target
1005 types. This option is only available if the toolchain has been built
1006 with plugin support enabled.
1009 Sort symbols by size. The size is computed as the difference between
1010 the value of the symbol and the value of the symbol with the next higher
1011 value. If the @code{bsd} output format is used the size of the symbol
1012 is printed, rather than the value, and @samp{-S} must be used in order
1013 both size and value to be printed.
1015 @item --special-syms
1016 Display symbols which have a target-specific special meaning. These
1017 symbols are usually used by the target for some special processing and
1018 are not normally helpful when included included in the normal symbol
1019 lists. For example for ARM targets this option would skip the mapping
1020 symbols used to mark transitions between ARM code, THUMB code and
1024 Include synthetic symbols in the output. These are special symbols
1025 created by the linker for various purposes. They are not shown by
1026 default since they are not part of the binary's original source code.
1028 @item --target=@var{bfdname}
1029 @cindex object code format
1030 Specify an object code format other than your system's default format.
1031 @xref{Target Selection}, for more information.
1038 @c man begin SEEALSO nm
1039 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1046 @c man title objcopy copy and translate object files
1049 @c man begin SYNOPSIS objcopy
1050 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1051 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1052 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1053 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1054 [@option{-S}|@option{--strip-all}]
1055 [@option{-g}|@option{--strip-debug}]
1056 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1057 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1058 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1059 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1060 [@option{--localize-hidden}]
1061 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1062 [@option{--globalize-symbol=}@var{symbolname}]
1063 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1064 [@option{-w}|@option{--wildcard}]
1065 [@option{-x}|@option{--discard-all}]
1066 [@option{-X}|@option{--discard-locals}]
1067 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1068 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1069 [@option{--interleave-width=}@var{width}]
1070 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1071 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1072 [@option{-p}|@option{--preserve-dates}]
1073 [@option{-D}|@option{--enable-deterministic-archives}]
1074 [@option{-U}|@option{--disable-deterministic-archives}]
1075 [@option{--debugging}]
1076 [@option{--gap-fill=}@var{val}]
1077 [@option{--pad-to=}@var{address}]
1078 [@option{--set-start=}@var{val}]
1079 [@option{--adjust-start=}@var{incr}]
1080 [@option{--change-addresses=}@var{incr}]
1081 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1082 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1083 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1084 [@option{--change-warnings}] [@option{--no-change-warnings}]
1085 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1086 [@option{--add-section} @var{sectionname}=@var{filename}]
1087 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1088 [@option{--long-section-names} @{enable,disable,keep@}]
1089 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1090 [@option{--reverse-bytes=}@var{num}]
1091 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1092 [@option{--redefine-sym} @var{old}=@var{new}]
1093 [@option{--redefine-syms=}@var{filename}]
1095 [@option{--keep-symbols=}@var{filename}]
1096 [@option{--strip-symbols=}@var{filename}]
1097 [@option{--strip-unneeded-symbols=}@var{filename}]
1098 [@option{--keep-global-symbols=}@var{filename}]
1099 [@option{--localize-symbols=}@var{filename}]
1100 [@option{--globalize-symbols=}@var{filename}]
1101 [@option{--weaken-symbols=}@var{filename}]
1102 [@option{--alt-machine-code=}@var{index}]
1103 [@option{--prefix-symbols=}@var{string}]
1104 [@option{--prefix-sections=}@var{string}]
1105 [@option{--prefix-alloc-sections=}@var{string}]
1106 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1107 [@option{--keep-file-symbols}]
1108 [@option{--only-keep-debug}]
1109 [@option{--strip-dwo}]
1110 [@option{--extract-dwo}]
1111 [@option{--extract-symbol}]
1112 [@option{--writable-text}]
1113 [@option{--readonly-text}]
1116 [@option{--file-alignment=}@var{num}]
1117 [@option{--heap=}@var{size}]
1118 [@option{--image-base=}@var{address}]
1119 [@option{--section-alignment=}@var{num}]
1120 [@option{--stack=}@var{size}]
1121 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1122 [@option{--compress-debug-sections}]
1123 [@option{--decompress-debug-sections}]
1124 [@option{--dwarf-depth=@var{n}}]
1125 [@option{--dwarf-start=@var{n}}]
1126 [@option{-v}|@option{--verbose}]
1127 [@option{-V}|@option{--version}]
1128 [@option{--help}] [@option{--info}]
1129 @var{infile} [@var{outfile}]
1133 @c man begin DESCRIPTION objcopy
1134 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1135 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1136 read and write the object files. It can write the destination object
1137 file in a format different from that of the source object file. The
1138 exact behavior of @command{objcopy} is controlled by command-line options.
1139 Note that @command{objcopy} should be able to copy a fully linked file
1140 between any two formats. However, copying a relocatable object file
1141 between any two formats may not work as expected.
1143 @command{objcopy} creates temporary files to do its translations and
1144 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1145 translation work; it has access to all the formats described in @sc{bfd}
1146 and thus is able to recognize most formats without being told
1147 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1149 @command{objcopy} can be used to generate S-records by using an output
1150 target of @samp{srec} (e.g., use @samp{-O srec}).
1152 @command{objcopy} can be used to generate a raw binary file by using an
1153 output target of @samp{binary} (e.g., use @option{-O binary}). When
1154 @command{objcopy} generates a raw binary file, it will essentially produce
1155 a memory dump of the contents of the input object file. All symbols and
1156 relocation information will be discarded. The memory dump will start at
1157 the load address of the lowest section copied into the output file.
1159 When generating an S-record or a raw binary file, it may be helpful to
1160 use @option{-S} to remove sections containing debugging information. In
1161 some cases @option{-R} will be useful to remove sections which contain
1162 information that is not needed by the binary file.
1164 Note---@command{objcopy} is not able to change the endianness of its input
1165 files. If the input format has an endianness (some formats do not),
1166 @command{objcopy} can only copy the inputs into file formats that have the
1167 same endianness or which have no endianness (e.g., @samp{srec}).
1168 (However, see the @option{--reverse-bytes} option.)
1172 @c man begin OPTIONS objcopy
1176 @itemx @var{outfile}
1177 The input and output files, respectively.
1178 If you do not specify @var{outfile}, @command{objcopy} creates a
1179 temporary file and destructively renames the result with
1180 the name of @var{infile}.
1182 @item -I @var{bfdname}
1183 @itemx --input-target=@var{bfdname}
1184 Consider the source file's object format to be @var{bfdname}, rather than
1185 attempting to deduce it. @xref{Target Selection}, for more information.
1187 @item -O @var{bfdname}
1188 @itemx --output-target=@var{bfdname}
1189 Write the output file using the object format @var{bfdname}.
1190 @xref{Target Selection}, for more information.
1192 @item -F @var{bfdname}
1193 @itemx --target=@var{bfdname}
1194 Use @var{bfdname} as the object format for both the input and the output
1195 file; i.e., simply transfer data from source to destination with no
1196 translation. @xref{Target Selection}, for more information.
1198 @item -B @var{bfdarch}
1199 @itemx --binary-architecture=@var{bfdarch}
1200 Useful when transforming a architecture-less input file into an object file.
1201 In this case the output architecture can be set to @var{bfdarch}. This
1202 option will be ignored if the input file has a known @var{bfdarch}. You
1203 can access this binary data inside a program by referencing the special
1204 symbols that are created by the conversion process. These symbols are
1205 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1206 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1207 an object file and then access it in your code using these symbols.
1209 @item -j @var{sectionpattern}
1210 @itemx --only-section=@var{sectionpattern}
1211 Copy only the indicated sections from the input file to the output file.
1212 This option may be given more than once. Note that using this option
1213 inappropriately may make the output file unusable. Wildcard
1214 characters are accepted in @var{sectionpattern}.
1216 @item -R @var{sectionpattern}
1217 @itemx --remove-section=@var{sectionpattern}
1218 Remove any section matching @var{sectionpattern} from the output file.
1219 This option may be given more than once. Note that using this option
1220 inappropriately may make the output file unusable. Wildcard
1221 characters are accepted in @var{sectionpattern}. Using both the
1222 @option{-j} and @option{-R} options together results in undefined
1227 Do not copy relocation and symbol information from the source file.
1230 @itemx --strip-debug
1231 Do not copy debugging symbols or sections from the source file.
1233 @item --strip-unneeded
1234 Strip all symbols that are not needed for relocation processing.
1236 @item -K @var{symbolname}
1237 @itemx --keep-symbol=@var{symbolname}
1238 When stripping symbols, keep symbol @var{symbolname} even if it would
1239 normally be stripped. This option may be given more than once.
1241 @item -N @var{symbolname}
1242 @itemx --strip-symbol=@var{symbolname}
1243 Do not copy symbol @var{symbolname} from the source file. This option
1244 may be given more than once.
1246 @item --strip-unneeded-symbol=@var{symbolname}
1247 Do not copy symbol @var{symbolname} from the source file unless it is needed
1248 by a relocation. This option may be given more than once.
1250 @item -G @var{symbolname}
1251 @itemx --keep-global-symbol=@var{symbolname}
1252 Keep only symbol @var{symbolname} global. Make all other symbols local
1253 to the file, so that they are not visible externally. This option may
1254 be given more than once.
1256 @item --localize-hidden
1257 In an ELF object, mark all symbols that have hidden or internal visibility
1258 as local. This option applies on top of symbol-specific localization options
1259 such as @option{-L}.
1261 @item -L @var{symbolname}
1262 @itemx --localize-symbol=@var{symbolname}
1263 Make symbol @var{symbolname} local to the file, so that it is not
1264 visible externally. This option may be given more than once.
1266 @item -W @var{symbolname}
1267 @itemx --weaken-symbol=@var{symbolname}
1268 Make symbol @var{symbolname} weak. This option may be given more than once.
1270 @item --globalize-symbol=@var{symbolname}
1271 Give symbol @var{symbolname} global scoping so that it is visible
1272 outside of the file in which it is defined. This option may be given
1277 Permit regular expressions in @var{symbolname}s used in other command
1278 line options. The question mark (?), asterisk (*), backslash (\) and
1279 square brackets ([]) operators can be used anywhere in the symbol
1280 name. If the first character of the symbol name is the exclamation
1281 point (!) then the sense of the switch is reversed for that symbol.
1288 would cause objcopy to weaken all symbols that start with ``fo''
1289 except for the symbol ``foo''.
1292 @itemx --discard-all
1293 Do not copy non-global symbols from the source file.
1294 @c FIXME any reason to prefer "non-global" to "local" here?
1297 @itemx --discard-locals
1298 Do not copy compiler-generated local symbols.
1299 (These usually start with @samp{L} or @samp{.}.)
1302 @itemx --byte=@var{byte}
1303 If interleaving has been enabled via the @option{--interleave} option
1304 then start the range of bytes to keep at the @var{byte}th byte.
1305 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1306 @var{breadth} is the value given by the @option{--interleave} option.
1308 @item -i [@var{breadth}]
1309 @itemx --interleave[=@var{breadth}]
1310 Only copy a range out of every @var{breadth} bytes. (Header data is
1311 not affected). Select which byte in the range begins the copy with
1312 the @option{--byte} option. Select the width of the range with the
1313 @option{--interleave-width} option.
1315 This option is useful for creating files to program @sc{rom}. It is
1316 typically used with an @code{srec} output target. Note that
1317 @command{objcopy} will complain if you do not specify the
1318 @option{--byte} option as well.
1320 The default interleave breadth is 4, so with @option{--byte} set to 0,
1321 @command{objcopy} would copy the first byte out of every four bytes
1322 from the input to the output.
1324 @item --interleave-width=@var{width}
1325 When used with the @option{--interleave} option, copy @var{width}
1326 bytes at a time. The start of the range of bytes to be copied is set
1327 by the @option{--byte} option, and the extent of the range is set with
1328 the @option{--interleave} option.
1330 The default value for this option is 1. The value of @var{width} plus
1331 the @var{byte} value set by the @option{--byte} option must not exceed
1332 the interleave breadth set by the @option{--interleave} option.
1334 This option can be used to create images for two 16-bit flashes interleaved
1335 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1336 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1337 commands. If the input was '12345678' then the outputs would be
1338 '1256' and '3478' respectively.
1341 @itemx --preserve-dates
1342 Set the access and modification dates of the output file to be the same
1343 as those of the input file.
1346 @itemx --enable-deterministic-archives
1347 @cindex deterministic archives
1348 @kindex --enable-deterministic-archives
1349 Operate in @emph{deterministic} mode. When copying archive members
1350 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1351 and use consistent file modes for all files.
1353 If @file{binutils} was configured with
1354 @option{--enable-deterministic-archives}, then this mode is on by default.
1355 It can be disabled with the @samp{-U} option, below.
1358 @itemx --disable-deterministic-archives
1359 @cindex deterministic archives
1360 @kindex --enable-deterministic-archives
1361 Do @emph{not} operate in @emph{deterministic} mode. This is the
1362 inverse of the @option{-D} option, above: when copying archive members
1363 and writing the archive index, use their actual UID, GID, timestamp,
1364 and file mode values.
1366 This is the default unless @file{binutils} was configured with
1367 @option{--enable-deterministic-archives}.
1370 Convert debugging information, if possible. This is not the default
1371 because only certain debugging formats are supported, and the
1372 conversion process can be time consuming.
1374 @item --gap-fill @var{val}
1375 Fill gaps between sections with @var{val}. This operation applies to
1376 the @emph{load address} (LMA) of the sections. It is done by increasing
1377 the size of the section with the lower address, and filling in the extra
1378 space created with @var{val}.
1380 @item --pad-to @var{address}
1381 Pad the output file up to the load address @var{address}. This is
1382 done by increasing the size of the last section. The extra space is
1383 filled in with the value specified by @option{--gap-fill} (default zero).
1385 @item --set-start @var{val}
1386 Set the start address of the new file to @var{val}. Not all object file
1387 formats support setting the start address.
1389 @item --change-start @var{incr}
1390 @itemx --adjust-start @var{incr}
1391 @cindex changing start address
1392 Change the start address by adding @var{incr}. Not all object file
1393 formats support setting the start address.
1395 @item --change-addresses @var{incr}
1396 @itemx --adjust-vma @var{incr}
1397 @cindex changing object addresses
1398 Change the VMA and LMA addresses of all sections, as well as the start
1399 address, by adding @var{incr}. Some object file formats do not permit
1400 section addresses to be changed arbitrarily. Note that this does not
1401 relocate the sections; if the program expects sections to be loaded at a
1402 certain address, and this option is used to change the sections such
1403 that they are loaded at a different address, the program may fail.
1405 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1406 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1407 @cindex changing section address
1408 Set or change both the VMA address and the LMA address of any section
1409 matching @var{sectionpattern}. If @samp{=} is used, the section
1410 address is set to @var{val}. Otherwise, @var{val} is added to or
1411 subtracted from the section address. See the comments under
1412 @option{--change-addresses}, above. If @var{sectionpattern} does not
1413 match any sections in the input file, a warning will be issued, unless
1414 @option{--no-change-warnings} is used.
1416 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1417 @cindex changing section LMA
1418 Set or change the LMA address of any sections matching
1419 @var{sectionpattern}. The LMA address is the address where the
1420 section will be loaded into memory at program load time. Normally
1421 this is the same as the VMA address, which is the address of the
1422 section at program run time, but on some systems, especially those
1423 where a program is held in ROM, the two can be different. If @samp{=}
1424 is used, the section address is set to @var{val}. Otherwise,
1425 @var{val} is added to or subtracted from the section address. See the
1426 comments under @option{--change-addresses}, above. If
1427 @var{sectionpattern} does not match any sections in the input file, a
1428 warning will be issued, unless @option{--no-change-warnings} is used.
1430 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1431 @cindex changing section VMA
1432 Set or change the VMA address of any section matching
1433 @var{sectionpattern}. The VMA address is the address where the
1434 section will be located once the program has started executing.
1435 Normally this is the same as the LMA address, which is the address
1436 where the section will be loaded into memory, but on some systems,
1437 especially those where a program is held in ROM, the two can be
1438 different. If @samp{=} is used, the section address is set to
1439 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1440 section address. See the comments under @option{--change-addresses},
1441 above. If @var{sectionpattern} does not match any sections in the
1442 input file, a warning will be issued, unless
1443 @option{--no-change-warnings} is used.
1445 @item --change-warnings
1446 @itemx --adjust-warnings
1447 If @option{--change-section-address} or @option{--change-section-lma} or
1448 @option{--change-section-vma} is used, and the section pattern does not
1449 match any sections, issue a warning. This is the default.
1451 @item --no-change-warnings
1452 @itemx --no-adjust-warnings
1453 Do not issue a warning if @option{--change-section-address} or
1454 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1455 if the section pattern does not match any sections.
1457 @item --set-section-flags @var{sectionpattern}=@var{flags}
1458 Set the flags for any sections matching @var{sectionpattern}. The
1459 @var{flags} argument is a comma separated string of flag names. The
1460 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1461 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1462 @samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1463 for a section which does not have contents, but it is not meaningful
1464 to clear the @samp{contents} flag of a section which does have
1465 contents--just remove the section instead. Not all flags are
1466 meaningful for all object file formats.
1468 @item --add-section @var{sectionname}=@var{filename}
1469 Add a new section named @var{sectionname} while copying the file. The
1470 contents of the new section are taken from the file @var{filename}. The
1471 size of the section will be the size of the file. This option only
1472 works on file formats which can support sections with arbitrary names.
1474 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1475 Rename a section from @var{oldname} to @var{newname}, optionally
1476 changing the section's flags to @var{flags} in the process. This has
1477 the advantage over usng a linker script to perform the rename in that
1478 the output stays as an object file and does not become a linked
1481 This option is particularly helpful when the input format is binary,
1482 since this will always create a section called .data. If for example,
1483 you wanted instead to create a section called .rodata containing binary
1484 data you could use the following command line to achieve it:
1487 objcopy -I binary -O <output_format> -B <architecture> \
1488 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1489 <input_binary_file> <output_object_file>
1492 @item --long-section-names @{enable,disable,keep@}
1493 Controls the handling of long section names when processing @code{COFF}
1494 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1495 is to preserve long section names if any are present in the input file.
1496 The @samp{enable} and @samp{disable} options forcibly enable or disable
1497 the use of long section names in the output object; when @samp{disable}
1498 is in effect, any long section names in the input object will be truncated.
1499 The @samp{enable} option will only emit long section names if any are
1500 present in the inputs; this is mostly the same as @samp{keep}, but it
1501 is left undefined whether the @samp{enable} option might force the
1502 creation of an empty string table in the output file.
1504 @item --change-leading-char
1505 Some object file formats use special characters at the start of
1506 symbols. The most common such character is underscore, which compilers
1507 often add before every symbol. This option tells @command{objcopy} to
1508 change the leading character of every symbol when it converts between
1509 object file formats. If the object file formats use the same leading
1510 character, this option has no effect. Otherwise, it will add a
1511 character, or remove a character, or change a character, as
1514 @item --remove-leading-char
1515 If the first character of a global symbol is a special symbol leading
1516 character used by the object file format, remove the character. The
1517 most common symbol leading character is underscore. This option will
1518 remove a leading underscore from all global symbols. This can be useful
1519 if you want to link together objects of different file formats with
1520 different conventions for symbol names. This is different from
1521 @option{--change-leading-char} because it always changes the symbol name
1522 when appropriate, regardless of the object file format of the output
1525 @item --reverse-bytes=@var{num}
1526 Reverse the bytes in a section with output contents. A section length must
1527 be evenly divisible by the value given in order for the swap to be able to
1528 take place. Reversing takes place before the interleaving is performed.
1530 This option is used typically in generating ROM images for problematic
1531 target systems. For example, on some target boards, the 32-bit words
1532 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1533 regardless of the CPU byte order. Depending on the programming model, the
1534 endianness of the ROM may need to be modified.
1536 Consider a simple file with a section containing the following eight
1537 bytes: @code{12345678}.
1539 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1540 output file would be ordered @code{21436587}.
1542 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1543 output file would be ordered @code{43218765}.
1545 By using @samp{--reverse-bytes=2} for the above example, followed by
1546 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1547 output file would be ordered @code{34127856}.
1549 @item --srec-len=@var{ival}
1550 Meaningful only for srec output. Set the maximum length of the Srecords
1551 being produced to @var{ival}. This length covers both address, data and
1554 @item --srec-forceS3
1555 Meaningful only for srec output. Avoid generation of S1/S2 records,
1556 creating S3-only record format.
1558 @item --redefine-sym @var{old}=@var{new}
1559 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1560 when one is trying link two things together for which you have no
1561 source, and there are name collisions.
1563 @item --redefine-syms=@var{filename}
1564 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1565 listed in the file @var{filename}. @var{filename} is simply a flat file,
1566 with one symbol pair per line. Line comments may be introduced by the hash
1567 character. This option may be given more than once.
1570 Change all global symbols in the file to be weak. This can be useful
1571 when building an object which will be linked against other objects using
1572 the @option{-R} option to the linker. This option is only effective when
1573 using an object file format which supports weak symbols.
1575 @item --keep-symbols=@var{filename}
1576 Apply @option{--keep-symbol} option to each symbol listed in the file
1577 @var{filename}. @var{filename} is simply a flat file, with one symbol
1578 name per line. Line comments may be introduced by the hash character.
1579 This option may be given more than once.
1581 @item --strip-symbols=@var{filename}
1582 Apply @option{--strip-symbol} option to each symbol listed in the file
1583 @var{filename}. @var{filename} is simply a flat file, with one symbol
1584 name per line. Line comments may be introduced by the hash character.
1585 This option may be given more than once.
1587 @item --strip-unneeded-symbols=@var{filename}
1588 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1589 the file @var{filename}. @var{filename} is simply a flat file, with one
1590 symbol name per line. Line comments may be introduced by the hash
1591 character. This option may be given more than once.
1593 @item --keep-global-symbols=@var{filename}
1594 Apply @option{--keep-global-symbol} option to each symbol listed in the
1595 file @var{filename}. @var{filename} is simply a flat file, with one
1596 symbol name per line. Line comments may be introduced by the hash
1597 character. This option may be given more than once.
1599 @item --localize-symbols=@var{filename}
1600 Apply @option{--localize-symbol} option to each symbol listed in the file
1601 @var{filename}. @var{filename} is simply a flat file, with one symbol
1602 name per line. Line comments may be introduced by the hash character.
1603 This option may be given more than once.
1605 @item --globalize-symbols=@var{filename}
1606 Apply @option{--globalize-symbol} option to each symbol listed in the file
1607 @var{filename}. @var{filename} is simply a flat file, with one symbol
1608 name per line. Line comments may be introduced by the hash character.
1609 This option may be given more than once.
1611 @item --weaken-symbols=@var{filename}
1612 Apply @option{--weaken-symbol} option to each symbol listed in the file
1613 @var{filename}. @var{filename} is simply a flat file, with one symbol
1614 name per line. Line comments may be introduced by the hash character.
1615 This option may be given more than once.
1617 @item --alt-machine-code=@var{index}
1618 If the output architecture has alternate machine codes, use the
1619 @var{index}th code instead of the default one. This is useful in case
1620 a machine is assigned an official code and the tool-chain adopts the
1621 new code, but other applications still depend on the original code
1622 being used. For ELF based architectures if the @var{index}
1623 alternative does not exist then the value is treated as an absolute
1624 number to be stored in the e_machine field of the ELF header.
1626 @item --writable-text
1627 Mark the output text as writable. This option isn't meaningful for all
1628 object file formats.
1630 @item --readonly-text
1631 Make the output text write protected. This option isn't meaningful for all
1632 object file formats.
1635 Mark the output file as demand paged. This option isn't meaningful for all
1636 object file formats.
1639 Mark the output file as impure. This option isn't meaningful for all
1640 object file formats.
1642 @item --prefix-symbols=@var{string}
1643 Prefix all symbols in the output file with @var{string}.
1645 @item --prefix-sections=@var{string}
1646 Prefix all section names in the output file with @var{string}.
1648 @item --prefix-alloc-sections=@var{string}
1649 Prefix all the names of all allocated sections in the output file with
1652 @item --add-gnu-debuglink=@var{path-to-file}
1653 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1654 and adds it to the output file.
1656 @item --keep-file-symbols
1657 When stripping a file, perhaps with @option{--strip-debug} or
1658 @option{--strip-unneeded}, retain any symbols specifying source file names,
1659 which would otherwise get stripped.
1661 @item --only-keep-debug
1662 Strip a file, removing contents of any sections that would not be
1663 stripped by @option{--strip-debug} and leaving the debugging sections
1664 intact. In ELF files, this preserves all note sections in the output.
1666 The intention is that this option will be used in conjunction with
1667 @option{--add-gnu-debuglink} to create a two part executable. One a
1668 stripped binary which will occupy less space in RAM and in a
1669 distribution and the second a debugging information file which is only
1670 needed if debugging abilities are required. The suggested procedure
1671 to create these files is as follows:
1674 @item Link the executable as normal. Assuming that is is called
1676 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1677 create a file containing the debugging info.
1678 @item Run @code{objcopy --strip-debug foo} to create a
1679 stripped executable.
1680 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1681 to add a link to the debugging info into the stripped executable.
1684 Note---the choice of @code{.dbg} as an extension for the debug info
1685 file is arbitrary. Also the @code{--only-keep-debug} step is
1686 optional. You could instead do this:
1689 @item Link the executable as normal.
1690 @item Copy @code{foo} to @code{foo.full}
1691 @item Run @code{objcopy --strip-debug foo}
1692 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1695 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1696 full executable. It does not have to be a file created by the
1697 @option{--only-keep-debug} switch.
1699 Note---this switch is only intended for use on fully linked files. It
1700 does not make sense to use it on object files where the debugging
1701 information may be incomplete. Besides the gnu_debuglink feature
1702 currently only supports the presence of one filename containing
1703 debugging information, not multiple filenames on a one-per-object-file
1707 Remove the contents of all DWARF .dwo sections, leaving the
1708 remaining debugging sections and all symbols intact.
1709 This option is intended for use by the compiler as part of
1710 the @option{-gsplit-dwarf} option, which splits debug information
1711 between the .o file and a separate .dwo file. The compiler
1712 generates all debug information in the same file, then uses
1713 the @option{--extract-dwo} option to copy the .dwo sections to
1714 the .dwo file, then the @option{--strip-dwo} option to remove
1715 those sections from the original .o file.
1718 Extract the contents of all DWARF .dwo sections. See the
1719 @option{--strip-dwo} option for more information.
1721 @item --file-alignment @var{num}
1722 Specify the file alignment. Sections in the file will always begin at
1723 file offsets which are multiples of this number. This defaults to
1725 [This option is specific to PE targets.]
1727 @item --heap @var{reserve}
1728 @itemx --heap @var{reserve},@var{commit}
1729 Specify the number of bytes of memory to reserve (and optionally commit)
1730 to be used as heap for this program.
1731 [This option is specific to PE targets.]
1733 @item --image-base @var{value}
1734 Use @var{value} as the base address of your program or dll. This is
1735 the lowest memory location that will be used when your program or dll
1736 is loaded. To reduce the need to relocate and improve performance of
1737 your dlls, each should have a unique base address and not overlap any
1738 other dlls. The default is 0x400000 for executables, and 0x10000000
1740 [This option is specific to PE targets.]
1742 @item --section-alignment @var{num}
1743 Sets the section alignment. Sections in memory will always begin at
1744 addresses which are a multiple of this number. Defaults to 0x1000.
1745 [This option is specific to PE targets.]
1747 @item --stack @var{reserve}
1748 @itemx --stack @var{reserve},@var{commit}
1749 Specify the number of bytes of memory to reserve (and optionally commit)
1750 to be used as stack for this program.
1751 [This option is specific to PE targets.]
1753 @item --subsystem @var{which}
1754 @itemx --subsystem @var{which}:@var{major}
1755 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1756 Specifies the subsystem under which your program will execute. The
1757 legal values for @var{which} are @code{native}, @code{windows},
1758 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1759 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1760 the subsystem version also. Numeric values are also accepted for
1762 [This option is specific to PE targets.]
1764 @item --extract-symbol
1765 Keep the file's section flags and symbols but remove all section data.
1766 Specifically, the option:
1769 @item removes the contents of all sections;
1770 @item sets the size of every section to zero; and
1771 @item sets the file's start address to zero.
1774 This option is used to build a @file{.sym} file for a VxWorks kernel.
1775 It can also be a useful way of reducing the size of a @option{--just-symbols}
1778 @item --compress-debug-sections
1779 Compress DWARF debug sections using zlib.
1781 @item --decompress-debug-sections
1782 Decompress DWARF debug sections using zlib.
1786 Show the version number of @command{objcopy}.
1790 Verbose output: list all object files modified. In the case of
1791 archives, @samp{objcopy -V} lists all members of the archive.
1794 Show a summary of the options to @command{objcopy}.
1797 Display a list showing all architectures and object formats available.
1803 @c man begin SEEALSO objcopy
1804 ld(1), objdump(1), and the Info entries for @file{binutils}.
1811 @cindex object file information
1814 @c man title objdump display information from object files.
1817 @c man begin SYNOPSIS objdump
1818 objdump [@option{-a}|@option{--archive-headers}]
1819 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1820 [@option{-C}|@option{--demangle}[=@var{style}] ]
1821 [@option{-d}|@option{--disassemble}]
1822 [@option{-D}|@option{--disassemble-all}]
1823 [@option{-z}|@option{--disassemble-zeroes}]
1824 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1825 [@option{-f}|@option{--file-headers}]
1826 [@option{-F}|@option{--file-offsets}]
1827 [@option{--file-start-context}]
1828 [@option{-g}|@option{--debugging}]
1829 [@option{-e}|@option{--debugging-tags}]
1830 [@option{-h}|@option{--section-headers}|@option{--headers}]
1831 [@option{-i}|@option{--info}]
1832 [@option{-j} @var{section}|@option{--section=}@var{section}]
1833 [@option{-l}|@option{--line-numbers}]
1834 [@option{-S}|@option{--source}]
1835 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1836 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1837 [@option{-p}|@option{--private-headers}]
1838 [@option{-P} @var{options}|@option{--private=}@var{options}]
1839 [@option{-r}|@option{--reloc}]
1840 [@option{-R}|@option{--dynamic-reloc}]
1841 [@option{-s}|@option{--full-contents}]
1842 [@option{-W[lLiaprmfFsoRt]}|
1843 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
1844 [@option{-G}|@option{--stabs}]
1845 [@option{-t}|@option{--syms}]
1846 [@option{-T}|@option{--dynamic-syms}]
1847 [@option{-x}|@option{--all-headers}]
1848 [@option{-w}|@option{--wide}]
1849 [@option{--start-address=}@var{address}]
1850 [@option{--stop-address=}@var{address}]
1851 [@option{--prefix-addresses}]
1852 [@option{--[no-]show-raw-insn}]
1853 [@option{--adjust-vma=}@var{offset}]
1854 [@option{--special-syms}]
1855 [@option{--prefix=}@var{prefix}]
1856 [@option{--prefix-strip=}@var{level}]
1857 [@option{--insn-width=}@var{width}]
1858 [@option{-V}|@option{--version}]
1859 [@option{-H}|@option{--help}]
1860 @var{objfile}@dots{}
1864 @c man begin DESCRIPTION objdump
1866 @command{objdump} displays information about one or more object files.
1867 The options control what particular information to display. This
1868 information is mostly useful to programmers who are working on the
1869 compilation tools, as opposed to programmers who just want their
1870 program to compile and work.
1872 @var{objfile}@dots{} are the object files to be examined. When you
1873 specify archives, @command{objdump} shows information on each of the member
1878 @c man begin OPTIONS objdump
1880 The long and short forms of options, shown here as alternatives, are
1881 equivalent. At least one option from the list
1882 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1886 @itemx --archive-header
1887 @cindex archive headers
1888 If any of the @var{objfile} files are archives, display the archive
1889 header information (in a format similar to @samp{ls -l}). Besides the
1890 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1891 the object file format of each archive member.
1893 @item --adjust-vma=@var{offset}
1894 @cindex section addresses in objdump
1895 @cindex VMA in objdump
1896 When dumping information, first add @var{offset} to all the section
1897 addresses. This is useful if the section addresses do not correspond to
1898 the symbol table, which can happen when putting sections at particular
1899 addresses when using a format which can not represent section addresses,
1902 @item -b @var{bfdname}
1903 @itemx --target=@var{bfdname}
1904 @cindex object code format
1905 Specify that the object-code format for the object files is
1906 @var{bfdname}. This option may not be necessary; @var{objdump} can
1907 automatically recognize many formats.
1911 objdump -b oasys -m vax -h fu.o
1914 displays summary information from the section headers (@option{-h}) of
1915 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1916 file in the format produced by Oasys compilers. You can list the
1917 formats available with the @option{-i} option.
1918 @xref{Target Selection}, for more information.
1921 @itemx --demangle[=@var{style}]
1922 @cindex demangling in objdump
1923 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1924 Besides removing any initial underscore prepended by the system, this
1925 makes C++ function names readable. Different compilers have different
1926 mangling styles. The optional demangling style argument can be used to
1927 choose an appropriate demangling style for your compiler. @xref{c++filt},
1928 for more information on demangling.
1932 Display debugging information. This attempts to parse STABS and IEEE
1933 debugging format information stored in the file and print it out using
1934 a C like syntax. If neither of these formats are found this option
1935 falls back on the @option{-W} option to print any DWARF information in
1939 @itemx --debugging-tags
1940 Like @option{-g}, but the information is generated in a format compatible
1944 @itemx --disassemble
1945 @cindex disassembling object code
1946 @cindex machine instructions
1947 Display the assembler mnemonics for the machine instructions from
1948 @var{objfile}. This option only disassembles those sections which are
1949 expected to contain instructions.
1952 @itemx --disassemble-all
1953 Like @option{-d}, but disassemble the contents of all sections, not just
1954 those expected to contain instructions.
1956 If the target is an ARM architecture this switch also has the effect
1957 of forcing the disassembler to decode pieces of data found in code
1958 sections as if they were instructions.
1960 @item --prefix-addresses
1961 When disassembling, print the complete address on each line. This is
1962 the older disassembly format.
1966 @itemx --endian=@{big|little@}
1968 @cindex disassembly endianness
1969 Specify the endianness of the object files. This only affects
1970 disassembly. This can be useful when disassembling a file format which
1971 does not describe endianness information, such as S-records.
1974 @itemx --file-headers
1975 @cindex object file header
1976 Display summary information from the overall header of
1977 each of the @var{objfile} files.
1980 @itemx --file-offsets
1981 @cindex object file offsets
1982 When disassembling sections, whenever a symbol is displayed, also
1983 display the file offset of the region of data that is about to be
1984 dumped. If zeroes are being skipped, then when disassembly resumes,
1985 tell the user how many zeroes were skipped and the file offset of the
1986 location from where the disassembly resumes. When dumping sections,
1987 display the file offset of the location from where the dump starts.
1989 @item --file-start-context
1990 @cindex source code context
1991 Specify that when displaying interlisted source code/disassembly
1992 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1993 context to the start of the file.
1996 @itemx --section-headers
1998 @cindex section headers
1999 Display summary information from the section headers of the
2002 File segments may be relocated to nonstandard addresses, for example by
2003 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2004 @command{ld}. However, some object file formats, such as a.out, do not
2005 store the starting address of the file segments. In those situations,
2006 although @command{ld} relocates the sections correctly, using @samp{objdump
2007 -h} to list the file section headers cannot show the correct addresses.
2008 Instead, it shows the usual addresses, which are implicit for the
2013 Print a summary of the options to @command{objdump} and exit.
2017 @cindex architectures available
2018 @cindex object formats available
2019 Display a list showing all architectures and object formats available
2020 for specification with @option{-b} or @option{-m}.
2023 @itemx --section=@var{name}
2024 @cindex section information
2025 Display information only for section @var{name}.
2028 @itemx --line-numbers
2029 @cindex source filenames for object files
2030 Label the display (using debugging information) with the filename and
2031 source line numbers corresponding to the object code or relocs shown.
2032 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2034 @item -m @var{machine}
2035 @itemx --architecture=@var{machine}
2036 @cindex architecture
2037 @cindex disassembly architecture
2038 Specify the architecture to use when disassembling object files. This
2039 can be useful when disassembling object files which do not describe
2040 architecture information, such as S-records. You can list the available
2041 architectures with the @option{-i} option.
2043 If the target is an ARM architecture then this switch has an
2044 additional effect. It restricts the disassembly to only those
2045 instructions supported by the architecture specified by @var{machine}.
2046 If it is necessary to use this switch because the input file does not
2047 contain any architecture information, but it is also desired to
2048 disassemble all the instructions use @option{-marm}.
2050 @item -M @var{options}
2051 @itemx --disassembler-options=@var{options}
2052 Pass target specific information to the disassembler. Only supported on
2053 some targets. If it is necessary to specify more than one
2054 disassembler option then multiple @option{-M} options can be used or
2055 can be placed together into a comma separated list.
2057 If the target is an ARM architecture then this switch can be used to
2058 select which register name set is used during disassembler. Specifying
2059 @option{-M reg-names-std} (the default) will select the register names as
2060 used in ARM's instruction set documentation, but with register 13 called
2061 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2062 @option{-M reg-names-apcs} will select the name set used by the ARM
2063 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2064 just use @samp{r} followed by the register number.
2066 There are also two variants on the APCS register naming scheme enabled
2067 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2068 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2069 with the normal register names or the special register names).
2071 This option can also be used for ARM architectures to force the
2072 disassembler to interpret all instructions as Thumb instructions by
2073 using the switch @option{--disassembler-options=force-thumb}. This can be
2074 useful when attempting to disassemble thumb code produced by other
2077 For the x86, some of the options duplicate functions of the @option{-m}
2078 switch, but allow finer grained control. Multiple selections from the
2079 following may be specified as a comma separated string.
2080 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
2081 the given architecture. @option{intel} and @option{att} select between
2082 intel syntax mode and AT&T syntax mode.
2083 @option{intel-mnemonic} and @option{att-mnemonic} select between
2084 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
2085 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
2086 @option{addr64}, @option{addr32},
2087 @option{addr16}, @option{data32} and @option{data16} specify the default
2088 address size and operand size. These four options will be overridden if
2089 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
2090 option string. Lastly, @option{suffix}, when in AT&T mode,
2091 instructs the disassembler to print a mnemonic suffix even when the
2092 suffix could be inferred by the operands.
2094 For PowerPC, @option{booke} controls the disassembly of BookE
2095 instructions. @option{32} and @option{64} select PowerPC and
2096 PowerPC64 disassembly, respectively. @option{e300} selects
2097 disassembly for the e300 family. @option{440} selects disassembly for
2098 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2099 single instructions of the PPC750CL.
2101 For MIPS, this option controls the printing of instruction mnemonic
2102 names and register names in disassembled instructions. Multiple
2103 selections from the following may be specified as a comma separated
2104 string, and invalid options are ignored:
2108 Print the 'raw' instruction mnemonic instead of some pseudo
2109 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2110 'sll' instead of 'nop', etc.
2113 Disassemble the virtualization ASE instructions.
2115 @item gpr-names=@var{ABI}
2116 Print GPR (general-purpose register) names as appropriate
2117 for the specified ABI. By default, GPR names are selected according to
2118 the ABI of the binary being disassembled.
2120 @item fpr-names=@var{ABI}
2121 Print FPR (floating-point register) names as
2122 appropriate for the specified ABI. By default, FPR numbers are printed
2125 @item cp0-names=@var{ARCH}
2126 Print CP0 (system control coprocessor; coprocessor 0) register names
2127 as appropriate for the CPU or architecture specified by
2128 @var{ARCH}. By default, CP0 register names are selected according to
2129 the architecture and CPU of the binary being disassembled.
2131 @item hwr-names=@var{ARCH}
2132 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2133 as appropriate for the CPU or architecture specified by
2134 @var{ARCH}. By default, HWR names are selected according to
2135 the architecture and CPU of the binary being disassembled.
2137 @item reg-names=@var{ABI}
2138 Print GPR and FPR names as appropriate for the selected ABI.
2140 @item reg-names=@var{ARCH}
2141 Print CPU-specific register names (CP0 register and HWR names)
2142 as appropriate for the selected CPU or architecture.
2145 For any of the options listed above, @var{ABI} or
2146 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2147 rather than names, for the selected types of registers.
2148 You can list the available values of @var{ABI} and @var{ARCH} using
2149 the @option{--help} option.
2151 For VAX, you can specify function entry addresses with @option{-M
2152 entry:0xf00ba}. You can use this multiple times to properly
2153 disassemble VAX binary files that don't contain symbol tables (like
2154 ROM dumps). In these cases, the function entry mask would otherwise
2155 be decoded as VAX instructions, which would probably lead the rest
2156 of the function being wrongly disassembled.
2159 @itemx --private-headers
2160 Print information that is specific to the object file format. The exact
2161 information printed depends upon the object file format. For some
2162 object file formats, no additional information is printed.
2164 @item -P @var{options}
2165 @itemx --private=@var{options}
2166 Print information that is specific to the object file format. The
2167 argument @var{options} is a comma separated list that depends on the
2168 format (the lists of options is displayed with the help).
2170 For XCOFF, the available options are: @option{header}, @option{aout},
2171 @option{sections}, @option{syms}, @option{relocs}, @option{lineno},
2172 @option{loader}, @option{except}, @option{typchk}, @option{traceback},
2173 @option{toc} and @option{ldinfo}.
2177 @cindex relocation entries, in object file
2178 Print the relocation entries of the file. If used with @option{-d} or
2179 @option{-D}, the relocations are printed interspersed with the
2183 @itemx --dynamic-reloc
2184 @cindex dynamic relocation entries, in object file
2185 Print the dynamic relocation entries of the file. This is only
2186 meaningful for dynamic objects, such as certain types of shared
2187 libraries. As for @option{-r}, if used with @option{-d} or
2188 @option{-D}, the relocations are printed interspersed with the
2192 @itemx --full-contents
2193 @cindex sections, full contents
2194 @cindex object file sections
2195 Display the full contents of any sections requested. By default all
2196 non-empty sections are displayed.
2200 @cindex source disassembly
2201 @cindex disassembly, with source
2202 Display source code intermixed with disassembly, if possible. Implies
2205 @item --prefix=@var{prefix}
2206 @cindex Add prefix to absolute paths
2207 Specify @var{prefix} to add to the absolute paths when used with
2210 @item --prefix-strip=@var{level}
2211 @cindex Strip absolute paths
2212 Indicate how many initial directory names to strip off the hardwired
2213 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2215 @item --show-raw-insn
2216 When disassembling instructions, print the instruction in hex as well as
2217 in symbolic form. This is the default except when
2218 @option{--prefix-addresses} is used.
2220 @item --no-show-raw-insn
2221 When disassembling instructions, do not print the instruction bytes.
2222 This is the default when @option{--prefix-addresses} is used.
2224 @item --insn-width=@var{width}
2225 @cindex Instruction width
2226 Display @var{width} bytes on a single line when disassembling
2229 @item -W[lLiaprmfFsoRt]
2230 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
2232 @cindex debug symbols
2233 Displays the contents of the debug sections in the file, if any are
2234 present. If one of the optional letters or words follows the switch
2235 then only data found in those specific sections will be dumped.
2237 Note that there is no single letter option to display the content of
2238 trace sections or .gdb_index.
2240 Note: the output from the @option{=info} option can also be affected
2241 by the options @option{--dwarf-depth}, the @option{--dwarf-start} and
2242 the @option{--dwarf-check}.
2244 @item --dwarf-depth=@var{n}
2245 Limit the dump of the @code{.debug_info} section to @var{n} children.
2246 This is only useful with @option{--dwarf=info}. The default is
2247 to print all DIEs; the special value 0 for @var{n} will also have this
2250 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2251 levels will not be printed. The range for @var{n} is zero-based.
2253 @item --dwarf-start=@var{n}
2254 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2255 useful with @option{--dwarf=info}.
2257 If specified, this option will suppress printing of any header
2258 information and all DIEs before the DIE numbered @var{n}. Only
2259 siblings and children of the specified DIE will be printed.
2261 This can be used in conjunction with @option{--dwarf-depth}.
2264 Enable additional checks for consistency of Dwarf information.
2270 @cindex debug symbols
2271 @cindex ELF object file format
2272 Display the full contents of any sections requested. Display the
2273 contents of the .stab and .stab.index and .stab.excl sections from an
2274 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2275 @code{.stab} debugging symbol-table entries are carried in an ELF
2276 section. In most other file formats, debugging symbol-table entries are
2277 interleaved with linkage symbols, and are visible in the @option{--syms}
2280 @item --start-address=@var{address}
2281 @cindex start-address
2282 Start displaying data at the specified address. This affects the output
2283 of the @option{-d}, @option{-r} and @option{-s} options.
2285 @item --stop-address=@var{address}
2286 @cindex stop-address
2287 Stop displaying data at the specified address. This affects the output
2288 of the @option{-d}, @option{-r} and @option{-s} options.
2292 @cindex symbol table entries, printing
2293 Print the symbol table entries of the file.
2294 This is similar to the information provided by the @samp{nm} program,
2295 although the display format is different. The format of the output
2296 depends upon the format of the file being dumped, but there are two main
2297 types. One looks like this:
2300 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2301 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2304 where the number inside the square brackets is the number of the entry
2305 in the symbol table, the @var{sec} number is the section number, the
2306 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2307 symbol's type, the @var{scl} number is the symbol's storage class and
2308 the @var{nx} value is the number of auxilary entries associated with
2309 the symbol. The last two fields are the symbol's value and its name.
2311 The other common output format, usually seen with ELF based files,
2315 00000000 l d .bss 00000000 .bss
2316 00000000 g .text 00000000 fred
2319 Here the first number is the symbol's value (sometimes refered to as
2320 its address). The next field is actually a set of characters and
2321 spaces indicating the flag bits that are set on the symbol. These
2322 characters are described below. Next is the section with which the
2323 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2324 not connected with any section), or @emph{*UND*} if the section is
2325 referenced in the file being dumped, but not defined there.
2327 After the section name comes another field, a number, which for common
2328 symbols is the alignment and for other symbol is the size. Finally
2329 the symbol's name is displayed.
2331 The flag characters are divided into 7 groups as follows:
2337 The symbol is a local (l), global (g), unique global (u), neither
2338 global nor local (a space) or both global and local (!). A
2339 symbol can be neither local or global for a variety of reasons, e.g.,
2340 because it is used for debugging, but it is probably an indication of
2341 a bug if it is ever both local and global. Unique global symbols are
2342 a GNU extension to the standard set of ELF symbol bindings. For such
2343 a symbol the dynamic linker will make sure that in the entire process
2344 there is just one symbol with this name and type in use.
2347 The symbol is weak (w) or strong (a space).
2350 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2353 The symbol is a warning (W) or a normal symbol (a space). A warning
2354 symbol's name is a message to be displayed if the symbol following the
2355 warning symbol is ever referenced.
2359 The symbol is an indirect reference to another symbol (I), a function
2360 to be evaluated during reloc processing (i) or a normal symbol (a
2365 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2366 normal symbol (a space).
2371 The symbol is the name of a function (F) or a file (f) or an object
2372 (O) or just a normal symbol (a space).
2376 @itemx --dynamic-syms
2377 @cindex dynamic symbol table entries, printing
2378 Print the dynamic symbol table entries of the file. This is only
2379 meaningful for dynamic objects, such as certain types of shared
2380 libraries. This is similar to the information provided by the @samp{nm}
2381 program when given the @option{-D} (@option{--dynamic}) option.
2383 @item --special-syms
2384 When displaying symbols include those which the target considers to be
2385 special in some way and which would not normally be of interest to the
2390 Print the version number of @command{objdump} and exit.
2393 @itemx --all-headers
2394 @cindex all header information, object file
2395 @cindex header information, all
2396 Display all available header information, including the symbol table and
2397 relocation entries. Using @option{-x} is equivalent to specifying all of
2398 @option{-a -f -h -p -r -t}.
2402 @cindex wide output, printing
2403 Format some lines for output devices that have more than 80 columns.
2404 Also do not truncate symbol names when they are displayed.
2407 @itemx --disassemble-zeroes
2408 Normally the disassembly output will skip blocks of zeroes. This
2409 option directs the disassembler to disassemble those blocks, just like
2416 @c man begin SEEALSO objdump
2417 nm(1), readelf(1), and the Info entries for @file{binutils}.
2425 @cindex archive contents
2426 @cindex symbol index
2428 @c man title ranlib generate index to archive.
2431 @c man begin SYNOPSIS ranlib
2432 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2436 @c man begin DESCRIPTION ranlib
2438 @command{ranlib} generates an index to the contents of an archive and
2439 stores it in the archive. The index lists each symbol defined by a
2440 member of an archive that is a relocatable object file.
2442 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2444 An archive with such an index speeds up linking to the library and
2445 allows routines in the library to call each other without regard to
2446 their placement in the archive.
2448 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2449 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2454 @c man begin OPTIONS ranlib
2460 Show usage information for @command{ranlib}.
2465 Show the version number of @command{ranlib}.
2468 @cindex deterministic archives
2469 @kindex --enable-deterministic-archives
2470 Operate in @emph{deterministic} mode. The symbol map archive member's
2471 header will show zero for the UID, GID, and timestamp. When this
2472 option is used, multiple runs will produce identical output files.
2474 This is the default unless @file{binutils} was configured with
2475 @option{--enable-deterministic-archives}.
2478 Update the timestamp of the symbol map of an archive.
2481 @cindex deterministic archives
2482 @kindex --enable-deterministic-archives
2483 Do @emph{not} operate in @emph{deterministic} mode. This is the
2484 inverse of the @samp{-D} option, above: the archive index will get
2485 actual UID, GID, timestamp, and file mode values.
2487 This is the default unless @file{binutils} was configured with
2488 @option{--enable-deterministic-archives}.
2494 @c man begin SEEALSO ranlib
2495 ar(1), nm(1), and the Info entries for @file{binutils}.
2503 @cindex section sizes
2505 @c man title size list section sizes and total size.
2508 @c man begin SYNOPSIS size
2509 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2511 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2513 [@option{-t}|@option{--totals}]
2514 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2515 [@var{objfile}@dots{}]
2519 @c man begin DESCRIPTION size
2521 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2522 size---for each of the object or archive files @var{objfile} in its
2523 argument list. By default, one line of output is generated for each
2524 object file or each module in an archive.
2526 @var{objfile}@dots{} are the object files to be examined.
2527 If none are specified, the file @code{a.out} will be used.
2531 @c man begin OPTIONS size
2533 The command line options have the following meanings:
2538 @itemx --format=@var{compatibility}
2539 @cindex @command{size} display format
2540 Using one of these options, you can choose whether the output from @sc{gnu}
2541 @command{size} resembles output from System V @command{size} (using @option{-A},
2542 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2543 @option{--format=berkeley}). The default is the one-line format similar to
2545 @c Bonus for doc-source readers: you can also say --format=strange (or
2546 @c anything else that starts with 's') for sysv, and --format=boring (or
2547 @c anything else that starts with 'b') for Berkeley.
2549 Here is an example of the Berkeley (default) format of output from
2552 $ size --format=Berkeley ranlib size
2553 text data bss dec hex filename
2554 294880 81920 11592 388392 5ed28 ranlib
2555 294880 81920 11888 388688 5ee50 size
2559 This is the same data, but displayed closer to System V conventions:
2562 $ size --format=SysV ranlib size
2580 Show a summary of acceptable arguments and options.
2585 @itemx --radix=@var{number}
2586 @cindex @command{size} number format
2587 @cindex radix for section sizes
2588 Using one of these options, you can control whether the size of each
2589 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2590 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2591 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2592 values (8, 10, 16) are supported. The total size is always given in two
2593 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2594 octal and hexadecimal if you're using @option{-o}.
2597 Print total size of common symbols in each file. When using Berkeley
2598 format these are included in the bss size.
2602 Show totals of all objects listed (Berkeley format listing mode only).
2604 @item --target=@var{bfdname}
2605 @cindex object code format
2606 Specify that the object-code format for @var{objfile} is
2607 @var{bfdname}. This option may not be necessary; @command{size} can
2608 automatically recognize many formats.
2609 @xref{Target Selection}, for more information.
2613 Display the version number of @command{size}.
2619 @c man begin SEEALSO size
2620 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2627 @cindex listings strings
2628 @cindex printing strings
2629 @cindex strings, printing
2631 @c man title strings print the strings of printable characters in files.
2634 @c man begin SYNOPSIS strings
2635 strings [@option{-afovV}] [@option{-}@var{min-len}]
2636 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2637 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2638 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2639 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2640 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2641 [@option{--help}] [@option{--version}] @var{file}@dots{}
2645 @c man begin DESCRIPTION strings
2647 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2648 character sequences that are at least 4 characters long (or the number
2649 given with the options below) and are followed by an unprintable
2650 character. By default, it only prints the strings from the initialized
2651 and loaded sections of object files; for other types of files, it prints
2652 the strings from the whole file.
2654 @command{strings} is mainly useful for determining the contents of non-text
2659 @c man begin OPTIONS strings
2665 Do not scan only the initialized and loaded sections of object files;
2666 scan the whole files.
2669 @itemx --print-file-name
2670 Print the name of the file before each string.
2673 Print a summary of the program usage on the standard output and exit.
2675 @item -@var{min-len}
2676 @itemx -n @var{min-len}
2677 @itemx --bytes=@var{min-len}
2678 Print sequences of characters that are at least @var{min-len} characters
2679 long, instead of the default 4.
2682 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2683 act like @samp{-t d} instead. Since we can not be compatible with both
2684 ways, we simply chose one.
2686 @item -t @var{radix}
2687 @itemx --radix=@var{radix}
2688 Print the offset within the file before each string. The single
2689 character argument specifies the radix of the offset---@samp{o} for
2690 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2692 @item -e @var{encoding}
2693 @itemx --encoding=@var{encoding}
2694 Select the character encoding of the strings that are to be found.
2695 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2696 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2697 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2698 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2699 littleendian. Useful for finding wide character strings. (@samp{l}
2700 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2702 @item -T @var{bfdname}
2703 @itemx --target=@var{bfdname}
2704 @cindex object code format
2705 Specify an object code format other than your system's default format.
2706 @xref{Target Selection}, for more information.
2711 Print the program version number on the standard output and exit.
2717 @c man begin SEEALSO strings
2718 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2719 and the Info entries for @file{binutils}.
2727 @cindex removing symbols
2728 @cindex discarding symbols
2729 @cindex symbols, discarding
2731 @c man title strip Discard symbols from object files.
2734 @c man begin SYNOPSIS strip
2735 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2736 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2737 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2738 [@option{-s}|@option{--strip-all}]
2739 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2740 [@option{--strip-dwo}]
2741 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2742 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2743 [@option{-w}|@option{--wildcard}]
2744 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2745 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2746 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2747 [@option{-D}|@option{--enable-deterministic-archives}]
2748 [@option{-U}|@option{--disable-deterministic-archives}]
2749 [@option{--keep-file-symbols}]
2750 [@option{--only-keep-debug}]
2751 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2752 [@option{--help}] [@option{--info}]
2753 @var{objfile}@dots{}
2757 @c man begin DESCRIPTION strip
2759 @sc{gnu} @command{strip} discards all symbols from object files
2760 @var{objfile}. The list of object files may include archives.
2761 At least one object file must be given.
2763 @command{strip} modifies the files named in its argument,
2764 rather than writing modified copies under different names.
2768 @c man begin OPTIONS strip
2771 @item -F @var{bfdname}
2772 @itemx --target=@var{bfdname}
2773 Treat the original @var{objfile} as a file with the object
2774 code format @var{bfdname}, and rewrite it in the same format.
2775 @xref{Target Selection}, for more information.
2778 Show a summary of the options to @command{strip} and exit.
2781 Display a list showing all architectures and object formats available.
2783 @item -I @var{bfdname}
2784 @itemx --input-target=@var{bfdname}
2785 Treat the original @var{objfile} as a file with the object
2786 code format @var{bfdname}.
2787 @xref{Target Selection}, for more information.
2789 @item -O @var{bfdname}
2790 @itemx --output-target=@var{bfdname}
2791 Replace @var{objfile} with a file in the output format @var{bfdname}.
2792 @xref{Target Selection}, for more information.
2794 @item -R @var{sectionname}
2795 @itemx --remove-section=@var{sectionname}
2796 Remove any section named @var{sectionname} from the output file. This
2797 option may be given more than once. Note that using this option
2798 inappropriately may make the output file unusable. The wildcard
2799 character @samp{*} may be given at the end of @var{sectionname}. If
2800 so, then any section starting with @var{sectionname} will be removed.
2809 @itemx --strip-debug
2810 Remove debugging symbols only.
2813 Remove the contents of all DWARF .dwo sections, leaving the
2814 remaining debugging sections and all symbols intact.
2815 See the description of this option in the @command{objcopy} section
2816 for more information.
2818 @item --strip-unneeded
2819 Remove all symbols that are not needed for relocation processing.
2821 @item -K @var{symbolname}
2822 @itemx --keep-symbol=@var{symbolname}
2823 When stripping symbols, keep symbol @var{symbolname} even if it would
2824 normally be stripped. This option may be given more than once.
2826 @item -N @var{symbolname}
2827 @itemx --strip-symbol=@var{symbolname}
2828 Remove symbol @var{symbolname} from the source file. This option may be
2829 given more than once, and may be combined with strip options other than
2833 Put the stripped output in @var{file}, rather than replacing the
2834 existing file. When this argument is used, only one @var{objfile}
2835 argument may be specified.
2838 @itemx --preserve-dates
2839 Preserve the access and modification dates of the file.
2842 @itemx --enable-deterministic-archives
2843 @cindex deterministic archives
2844 @kindex --enable-deterministic-archives
2845 Operate in @emph{deterministic} mode. When copying archive members
2846 and writing the archive index, use zero for UIDs, GIDs, timestamps,
2847 and use consistent file modes for all files.
2849 If @file{binutils} was configured with
2850 @option{--enable-deterministic-archives}, then this mode is on by default.
2851 It can be disabled with the @samp{-U} option, below.
2854 @itemx --disable-deterministic-archives
2855 @cindex deterministic archives
2856 @kindex --enable-deterministic-archives
2857 Do @emph{not} operate in @emph{deterministic} mode. This is the
2858 inverse of the @option{-D} option, above: when copying archive members
2859 and writing the archive index, use their actual UID, GID, timestamp,
2860 and file mode values.
2862 This is the default unless @file{binutils} was configured with
2863 @option{--enable-deterministic-archives}.
2867 Permit regular expressions in @var{symbolname}s used in other command
2868 line options. The question mark (?), asterisk (*), backslash (\) and
2869 square brackets ([]) operators can be used anywhere in the symbol
2870 name. If the first character of the symbol name is the exclamation
2871 point (!) then the sense of the switch is reversed for that symbol.
2878 would cause strip to only keep symbols that start with the letters
2879 ``fo'', but to discard the symbol ``foo''.
2882 @itemx --discard-all
2883 Remove non-global symbols.
2886 @itemx --discard-locals
2887 Remove compiler-generated local symbols.
2888 (These usually start with @samp{L} or @samp{.}.)
2890 @item --keep-file-symbols
2891 When stripping a file, perhaps with @option{--strip-debug} or
2892 @option{--strip-unneeded}, retain any symbols specifying source file names,
2893 which would otherwise get stripped.
2895 @item --only-keep-debug
2896 Strip a file, removing contents of any sections that would not be
2897 stripped by @option{--strip-debug} and leaving the debugging sections
2898 intact. In ELF files, this preserves all note sections in the output.
2900 The intention is that this option will be used in conjunction with
2901 @option{--add-gnu-debuglink} to create a two part executable. One a
2902 stripped binary which will occupy less space in RAM and in a
2903 distribution and the second a debugging information file which is only
2904 needed if debugging abilities are required. The suggested procedure
2905 to create these files is as follows:
2908 @item Link the executable as normal. Assuming that is is called
2910 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2911 create a file containing the debugging info.
2912 @item Run @code{objcopy --strip-debug foo} to create a
2913 stripped executable.
2914 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2915 to add a link to the debugging info into the stripped executable.
2918 Note---the choice of @code{.dbg} as an extension for the debug info
2919 file is arbitrary. Also the @code{--only-keep-debug} step is
2920 optional. You could instead do this:
2923 @item Link the executable as normal.
2924 @item Copy @code{foo} to @code{foo.full}
2925 @item Run @code{strip --strip-debug foo}
2926 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2929 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2930 full executable. It does not have to be a file created by the
2931 @option{--only-keep-debug} switch.
2933 Note---this switch is only intended for use on fully linked files. It
2934 does not make sense to use it on object files where the debugging
2935 information may be incomplete. Besides the gnu_debuglink feature
2936 currently only supports the presence of one filename containing
2937 debugging information, not multiple filenames on a one-per-object-file
2942 Show the version number for @command{strip}.
2946 Verbose output: list all object files modified. In the case of
2947 archives, @samp{strip -v} lists all members of the archive.
2953 @c man begin SEEALSO strip
2954 the Info entries for @file{binutils}.
2958 @node c++filt, addr2line, strip, Top
2962 @cindex demangling C++ symbols
2964 @c man title cxxfilt Demangle C++ and Java symbols.
2967 @c man begin SYNOPSIS cxxfilt
2968 c++filt [@option{-_}|@option{--strip-underscore}]
2969 [@option{-n}|@option{--no-strip-underscore}]
2970 [@option{-p}|@option{--no-params}]
2971 [@option{-t}|@option{--types}]
2972 [@option{-i}|@option{--no-verbose}]
2973 [@option{-s} @var{format}|@option{--format=}@var{format}]
2974 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2978 @c man begin DESCRIPTION cxxfilt
2981 The C++ and Java languages provide function overloading, which means
2982 that you can write many functions with the same name, providing that
2983 each function takes parameters of different types. In order to be
2984 able to distinguish these similarly named functions C++ and Java
2985 encode them into a low-level assembler name which uniquely identifies
2986 each different version. This process is known as @dfn{mangling}. The
2988 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2989 MS-DOS this program is named @command{CXXFILT}.}
2990 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2991 names into user-level names so that they can be read.
2993 Every alphanumeric word (consisting of letters, digits, underscores,
2994 dollars, or periods) seen in the input is a potential mangled name.
2995 If the name decodes into a C++ name, the C++ name replaces the
2996 low-level name in the output, otherwise the original word is output.
2997 In this way you can pass an entire assembler source file, containing
2998 mangled names, through @command{c++filt} and see the same source file
2999 containing demangled names.
3001 You can also use @command{c++filt} to decipher individual symbols by
3002 passing them on the command line:
3005 c++filt @var{symbol}
3008 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3009 names from the standard input instead. All the results are printed on
3010 the standard output. The difference between reading names from the
3011 command line versus reading names from the standard input is that
3012 command line arguments are expected to be just mangled names and no
3013 checking is performed to separate them from surrounding text. Thus
3020 will work and demangle the name to ``f()'' whereas:
3026 will not work. (Note the extra comma at the end of the mangled
3027 name which makes it invalid). This command however will work:
3030 echo _Z1fv, | c++filt -n
3033 and will display ``f(),'', i.e., the demangled name followed by a
3034 trailing comma. This behaviour is because when the names are read
3035 from the standard input it is expected that they might be part of an
3036 assembler source file where there might be extra, extraneous
3037 characters trailing after a mangled name. For example:
3040 .type _Z1fv, @@function
3045 @c man begin OPTIONS cxxfilt
3049 @itemx --strip-underscore
3050 On some systems, both the C and C++ compilers put an underscore in front
3051 of every name. For example, the C name @code{foo} gets the low-level
3052 name @code{_foo}. This option removes the initial underscore. Whether
3053 @command{c++filt} removes the underscore by default is target dependent.
3056 @itemx --no-strip-underscore
3057 Do not remove the initial underscore.
3061 When demangling the name of a function, do not display the types of
3062 the function's parameters.
3066 Attempt to demangle types as well as function names. This is disabled
3067 by default since mangled types are normally only used internally in
3068 the compiler, and they can be confused with non-mangled names. For example,
3069 a function called ``a'' treated as a mangled type name would be
3070 demangled to ``signed char''.
3074 Do not include implementation details (if any) in the demangled
3077 @item -s @var{format}
3078 @itemx --format=@var{format}
3079 @command{c++filt} can decode various methods of mangling, used by
3080 different compilers. The argument to this option selects which
3085 Automatic selection based on executable (the default method)
3087 the one used by the @sc{gnu} C++ compiler (g++)
3089 the one used by the Lucid compiler (lcc)
3091 the one specified by the C++ Annotated Reference Manual
3093 the one used by the HP compiler (aCC)
3095 the one used by the EDG compiler
3097 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3099 the one used by the @sc{gnu} Java compiler (gcj)
3101 the one used by the @sc{gnu} Ada compiler (GNAT).
3105 Print a summary of the options to @command{c++filt} and exit.
3108 Print the version number of @command{c++filt} and exit.
3114 @c man begin SEEALSO cxxfilt
3115 the Info entries for @file{binutils}.
3120 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3121 user interface are subject to change in future releases. In particular,
3122 a command-line option may be required in the future to decode a name
3123 passed as an argument on the command line; in other words,
3126 c++filt @var{symbol}
3130 may in a future release become
3133 c++filt @var{option} @var{symbol}
3141 @cindex address to file name and line number
3143 @c man title addr2line convert addresses into file names and line numbers.
3146 @c man begin SYNOPSIS addr2line
3147 addr2line [@option{-a}|@option{--addresses}]
3148 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3149 [@option{-C}|@option{--demangle}[=@var{style}]]
3150 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3151 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3152 [@option{-i}|@option{--inlines}]
3153 [@option{-p}|@option{--pretty-print}]
3154 [@option{-j}|@option{--section=}@var{name}]
3155 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3160 @c man begin DESCRIPTION addr2line
3162 @command{addr2line} translates addresses into file names and line numbers.
3163 Given an address in an executable or an offset in a section of a relocatable
3164 object, it uses the debugging information to figure out which file name and
3165 line number are associated with it.
3167 The executable or relocatable object to use is specified with the @option{-e}
3168 option. The default is the file @file{a.out}. The section in the relocatable
3169 object to use is specified with the @option{-j} option.
3171 @command{addr2line} has two modes of operation.
3173 In the first, hexadecimal addresses are specified on the command line,
3174 and @command{addr2line} displays the file name and line number for each
3177 In the second, @command{addr2line} reads hexadecimal addresses from
3178 standard input, and prints the file name and line number for each
3179 address on standard output. In this mode, @command{addr2line} may be used
3180 in a pipe to convert dynamically chosen addresses.
3182 The format of the output is @samp{FILENAME:LINENO}. The file name and
3183 line number for each input address is printed on separate lines.
3185 If the @option{-f} option is used, then each @samp{FILENAME:LINENO}
3186 line is preceded by @samp{FUNCTIONNAME} which is the name of the
3187 function containing the address.
3189 If the @option{-i} option is used and the code at the given address is
3190 present there because of inlining by the compiler then the
3191 @samp{@{FUNCTIONNAME@} FILENAME:LINENO} information for the inlining
3192 function will be displayed afterwards. This continues recursively
3193 until there is no more inlining to report.
3195 If the @option{-a} option is used then the output is prefixed by the
3198 If the @option{-p} option is used then the output for each input
3199 address is displayed on one, possibly quite long, line. If
3200 @option{-p} is not used then the output is broken up into multiple
3201 lines, based on the paragraphs above.
3203 If the file name or function name can not be determined,
3204 @command{addr2line} will print two question marks in their place. If the
3205 line number can not be determined, @command{addr2line} will print 0.
3209 @c man begin OPTIONS addr2line
3211 The long and short forms of options, shown here as alternatives, are
3217 Display the address before the function name, file and line number
3218 information. The address is printed with a @samp{0x} prefix to easily
3221 @item -b @var{bfdname}
3222 @itemx --target=@var{bfdname}
3223 @cindex object code format
3224 Specify that the object-code format for the object files is
3228 @itemx --demangle[=@var{style}]
3229 @cindex demangling in objdump
3230 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3231 Besides removing any initial underscore prepended by the system, this
3232 makes C++ function names readable. Different compilers have different
3233 mangling styles. The optional demangling style argument can be used to
3234 choose an appropriate demangling style for your compiler. @xref{c++filt},
3235 for more information on demangling.
3237 @item -e @var{filename}
3238 @itemx --exe=@var{filename}
3239 Specify the name of the executable for which addresses should be
3240 translated. The default file is @file{a.out}.
3244 Display function names as well as file and line number information.
3248 Display only the base of each file name.
3252 If the address belongs to a function that was inlined, the source
3253 information for all enclosing scopes back to the first non-inlined
3254 function will also be printed. For example, if @code{main} inlines
3255 @code{callee1} which inlines @code{callee2}, and address is from
3256 @code{callee2}, the source information for @code{callee1} and @code{main}
3257 will also be printed.
3261 Read offsets relative to the specified section instead of absolute addresses.
3264 @itemx --pretty-print
3265 Make the output more human friendly: each location are printed on one line.
3266 If option @option{-i} is specified, lines for all enclosing scopes are
3267 prefixed with @samp{(inlined by)}.
3273 @c man begin SEEALSO addr2line
3274 Info entries for @file{binutils}.
3281 @command{nlmconv} converts a relocatable object file into a NetWare
3285 @command{nlmconv} currently works with @samp{i386} object
3286 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3287 object files in @sc{elf}, or @code{a.out} format@footnote{
3288 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3289 format in the Binary File Descriptor library. It has only been tested
3290 with the above formats.}.
3294 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3295 utilities, since it is only useful for NLM targets.
3298 @c man title nlmconv converts object code into an NLM.
3301 @c man begin SYNOPSIS nlmconv
3302 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3303 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3304 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3305 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3306 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3307 @var{infile} @var{outfile}
3311 @c man begin DESCRIPTION nlmconv
3313 @command{nlmconv} converts the relocatable @samp{i386} object file
3314 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3315 reading @var{headerfile} for NLM header information. For instructions
3316 on writing the NLM command file language used in header files, see the
3317 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3318 Development and Tools Overview}, which is part of the NLM Software
3319 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3320 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3323 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3326 @command{nlmconv} can perform a link step. In other words, you can list
3327 more than one object file for input if you list them in the definitions
3328 file (rather than simply specifying one input file on the command line).
3329 In this case, @command{nlmconv} calls the linker for you.
3333 @c man begin OPTIONS nlmconv
3336 @item -I @var{bfdname}
3337 @itemx --input-target=@var{bfdname}
3338 Object format of the input file. @command{nlmconv} can usually determine
3339 the format of a given file (so no default is necessary).
3340 @xref{Target Selection}, for more information.
3342 @item -O @var{bfdname}
3343 @itemx --output-target=@var{bfdname}
3344 Object format of the output file. @command{nlmconv} infers the output
3345 format based on the input format, e.g. for a @samp{i386} input file the
3346 output format is @samp{nlm32-i386}.
3347 @xref{Target Selection}, for more information.
3349 @item -T @var{headerfile}
3350 @itemx --header-file=@var{headerfile}
3351 Reads @var{headerfile} for NLM header information. For instructions on
3352 writing the NLM command file language used in header files, see@ see the
3353 @samp{linkers} section, of the @cite{NLM Development and Tools
3354 Overview}, which is part of the NLM Software Developer's Kit, available
3359 Displays (on standard error) the linker command line used by @command{nlmconv}.
3361 @item -l @var{linker}
3362 @itemx --linker=@var{linker}
3363 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3368 Prints a usage summary.
3372 Prints the version number for @command{nlmconv}.
3378 @c man begin SEEALSO nlmconv
3379 the Info entries for @file{binutils}.
3386 @command{windmc} may be used to generator Windows message resources.
3389 @emph{Warning:} @command{windmc} is not always built as part of the binary
3390 utilities, since it is only useful for Windows targets.
3393 @c man title windmc generates Windows message resources.
3396 @c man begin SYNOPSIS windmc
3397 windmc [options] input-file
3401 @c man begin DESCRIPTION windmc
3403 @command{windmc} reads message definitions from an input file (.mc) and
3404 translate them into a set of output files. The output files may be of
3409 A C header file containing the message definitions.
3412 A resource file compilable by the @command{windres} tool.
3415 One or more binary files containing the resource data for a specific
3419 A C include file that maps message id's to their symbolic name.
3422 The exact description of these different formats is available in
3423 documentation from Microsoft.
3425 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3426 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3427 Windows Message Compiler.
3431 @c man begin OPTIONS windmc
3436 Specifies that the input file specified is ASCII. This is the default
3441 Specifies that messages in the output @code{bin} files should be in ASCII
3446 Specifies that @code{bin} filenames should have to be prefixed by the
3447 basename of the source file.
3451 Sets the customer bit in all message id's.
3453 @item -C @var{codepage}
3454 @itemx --codepage_in @var{codepage}
3455 Sets the default codepage to be used to convert input file to UTF16. The
3456 default is ocdepage 1252.
3459 @itemx --decimal_values
3460 Outputs the constants in the header file in decimal. Default is using
3464 @itemx --extension @var{ext}
3465 The extension for the header file. The default is .h extension.
3467 @item -F @var{target}
3468 @itemx --target @var{target}
3469 Specify the BFD format to use for a bin file as output. This
3470 is a BFD target name; you can use the @option{--help} option to see a list
3471 of supported targets. Normally @command{windmc} will use the default
3472 format, which is the first one listed by the @option{--help} option.
3474 @ref{Target Selection}.
3478 @itemx --headerdir @var{path}
3479 The target directory of the generated header file. The default is the
3484 Displays a list of command line options and then exits.
3486 @item -m @var{characters}
3487 @itemx --maxlength @var{characters}
3488 Instructs @command{windmc} to generate a warning if the length
3489 of any message exceeds the number specified.
3492 @itemx --nullterminate
3493 Terminate message text in @code{bin} files by zero. By default they are
3494 terminated by CR/LF.
3497 @itemx --hresult_use
3498 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3499 file, using HRESULT definitions. Status codes are used if the flag is not
3502 @item -O @var{codepage}
3503 @itemx --codepage_out @var{codepage}
3504 Sets the default codepage to be used to output text files. The default
3508 @itemx --rcdir @var{path}
3509 The target directory for the generated @code{rc} script and the generated
3510 @code{bin} files that the resource compiler script includes. The default
3511 is the current directory.
3515 Specifies that the input file is UTF16.
3518 @itemx --unicode_out
3519 Specifies that messages in the output @code{bin} file should be in UTF16
3520 format. This is the default behaviour.
3524 Enable verbose mode.
3528 Prints the version number for @command{windmc}.
3531 @itemx --xdgb @var{path}
3532 The path of the @code{dbg} C include file that maps message id's to the
3533 symbolic name. No such file is generated without specifying the switch.
3539 @c man begin SEEALSO windmc
3540 the Info entries for @file{binutils}.
3547 @command{windres} may be used to manipulate Windows resources.
3550 @emph{Warning:} @command{windres} is not always built as part of the binary
3551 utilities, since it is only useful for Windows targets.
3554 @c man title windres manipulate Windows resources.
3557 @c man begin SYNOPSIS windres
3558 windres [options] [input-file] [output-file]
3562 @c man begin DESCRIPTION windres
3564 @command{windres} reads resources from an input file and copies them into
3565 an output file. Either file may be in one of three formats:
3569 A text format read by the Resource Compiler.
3572 A binary format generated by the Resource Compiler.
3575 A COFF object or executable.
3578 The exact description of these different formats is available in
3579 documentation from Microsoft.
3581 When @command{windres} converts from the @code{rc} format to the @code{res}
3582 format, it is acting like the Windows Resource Compiler. When
3583 @command{windres} converts from the @code{res} format to the @code{coff}
3584 format, it is acting like the Windows @code{CVTRES} program.
3586 When @command{windres} generates an @code{rc} file, the output is similar
3587 but not identical to the format expected for the input. When an input
3588 @code{rc} file refers to an external filename, an output @code{rc} file
3589 will instead include the file contents.
3591 If the input or output format is not specified, @command{windres} will
3592 guess based on the file name, or, for the input file, the file contents.
3593 A file with an extension of @file{.rc} will be treated as an @code{rc}
3594 file, a file with an extension of @file{.res} will be treated as a
3595 @code{res} file, and a file with an extension of @file{.o} or
3596 @file{.exe} will be treated as a @code{coff} file.
3598 If no output file is specified, @command{windres} will print the resources
3599 in @code{rc} format to standard output.
3601 The normal use is for you to write an @code{rc} file, use @command{windres}
3602 to convert it to a COFF object file, and then link the COFF file into
3603 your application. This will make the resources described in the
3604 @code{rc} file available to Windows.
3608 @c man begin OPTIONS windres
3611 @item -i @var{filename}
3612 @itemx --input @var{filename}
3613 The name of the input file. If this option is not used, then
3614 @command{windres} will use the first non-option argument as the input file
3615 name. If there are no non-option arguments, then @command{windres} will
3616 read from standard input. @command{windres} can not read a COFF file from
3619 @item -o @var{filename}
3620 @itemx --output @var{filename}
3621 The name of the output file. If this option is not used, then
3622 @command{windres} will use the first non-option argument, after any used
3623 for the input file name, as the output file name. If there is no
3624 non-option argument, then @command{windres} will write to standard output.
3625 @command{windres} can not write a COFF file to standard output. Note,
3626 for compatibility with @command{rc} the option @option{-fo} is also
3627 accepted, but its use is not recommended.
3629 @item -J @var{format}
3630 @itemx --input-format @var{format}
3631 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3632 @samp{coff}. If no input format is specified, @command{windres} will
3633 guess, as described above.
3635 @item -O @var{format}
3636 @itemx --output-format @var{format}
3637 The output format to generate. @var{format} may be @samp{res},
3638 @samp{rc}, or @samp{coff}. If no output format is specified,
3639 @command{windres} will guess, as described above.
3641 @item -F @var{target}
3642 @itemx --target @var{target}
3643 Specify the BFD format to use for a COFF file as input or output. This
3644 is a BFD target name; you can use the @option{--help} option to see a list
3645 of supported targets. Normally @command{windres} will use the default
3646 format, which is the first one listed by the @option{--help} option.
3648 @ref{Target Selection}.
3651 @item --preprocessor @var{program}
3652 When @command{windres} reads an @code{rc} file, it runs it through the C
3653 preprocessor first. This option may be used to specify the preprocessor
3654 to use, including any leading arguments. The default preprocessor
3655 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3657 @item --preprocessor-arg @var{option}
3658 When @command{windres} reads an @code{rc} file, it runs it through
3659 the C preprocessor first. This option may be used to specify additional
3660 text to be passed to preprocessor on its command line.
3661 This option can be used multiple times to add multiple options to the
3662 preprocessor command line.
3664 @item -I @var{directory}
3665 @itemx --include-dir @var{directory}
3666 Specify an include directory to use when reading an @code{rc} file.
3667 @command{windres} will pass this to the preprocessor as an @option{-I}
3668 option. @command{windres} will also search this directory when looking for
3669 files named in the @code{rc} file. If the argument passed to this command
3670 matches any of the supported @var{formats} (as described in the @option{-J}
3671 option), it will issue a deprecation warning, and behave just like the
3672 @option{-J} option. New programs should not use this behaviour. If a
3673 directory happens to match a @var{format}, simple prefix it with @samp{./}
3674 to disable the backward compatibility.
3676 @item -D @var{target}
3677 @itemx --define @var{sym}[=@var{val}]
3678 Specify a @option{-D} option to pass to the preprocessor when reading an
3681 @item -U @var{target}
3682 @itemx --undefine @var{sym}
3683 Specify a @option{-U} option to pass to the preprocessor when reading an
3687 Ignored for compatibility with rc.
3690 Enable verbose mode. This tells you what the preprocessor is if you
3694 @item --codepage @var{val}
3695 Specify the default codepage to use when reading an @code{rc} file.
3696 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3697 codepage code. The valid range is from zero up to 0xffff, but the
3698 validity of the codepage is host and configuration dependent.
3701 @item --language @var{val}
3702 Specify the default language to use when reading an @code{rc} file.
3703 @var{val} should be a hexadecimal language code. The low eight bits are
3704 the language, and the high eight bits are the sublanguage.
3706 @item --use-temp-file
3707 Use a temporary file to instead of using popen to read the output of
3708 the preprocessor. Use this option if the popen implementation is buggy
3709 on the host (eg., certain non-English language versions of Windows 95 and
3710 Windows 98 are known to have buggy popen where the output will instead
3713 @item --no-use-temp-file
3714 Use popen, not a temporary file, to read the output of the preprocessor.
3715 This is the default behaviour.
3719 Prints a usage summary.
3723 Prints the version number for @command{windres}.
3726 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3727 this will turn on parser debugging.
3733 @c man begin SEEALSO windres
3734 the Info entries for @file{binutils}.
3743 @command{dlltool} is used to create the files needed to create dynamic
3744 link libraries (DLLs) on systems which understand PE format image
3745 files such as Windows. A DLL contains an export table which contains
3746 information that the runtime loader needs to resolve references from a
3747 referencing program.
3749 The export table is generated by this program by reading in a
3750 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3751 will be in the DLL. A @file{.o} file can contain information in
3752 special @samp{.drectve} sections with export information.
3755 @emph{Note:} @command{dlltool} is not always built as part of the
3756 binary utilities, since it is only useful for those targets which
3760 @c man title dlltool Create files needed to build and use DLLs.
3763 @c man begin SYNOPSIS dlltool
3764 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3765 [@option{-b}|@option{--base-file} @var{base-file-name}]
3766 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3767 [@option{-z}|@option{--output-def} @var{def-file-name}]
3768 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3769 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3770 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3771 [@option{--exclude-symbols} @var{list}]
3772 [@option{--no-default-excludes}]
3773 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3774 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3775 [@option{-a}|@option{--add-indirect}]
3776 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3777 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3778 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3779 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3780 [@option{--use-nul-prefixed-import-tables}]
3781 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3782 [@option{-i}|@option{--interwork}]
3783 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3784 [@option{-v}|@option{--verbose}]
3785 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3786 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
3787 [object-file @dots{}]
3791 @c man begin DESCRIPTION dlltool
3793 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3794 @option{-b} options as well as object files specified on the command
3795 line. It then processes these inputs and if the @option{-e} option has
3796 been specified it creates a exports file. If the @option{-l} option
3797 has been specified it creates a library file and if the @option{-z} option
3798 has been specified it creates a def file. Any or all of the @option{-e},
3799 @option{-l} and @option{-z} options can be present in one invocation of
3802 When creating a DLL, along with the source for the DLL, it is necessary
3803 to have three other files. @command{dlltool} can help with the creation of
3806 The first file is a @file{.def} file which specifies which functions are
3807 exported from the DLL, which functions the DLL imports, and so on. This
3808 is a text file and can be created by hand, or @command{dlltool} can be used
3809 to create it using the @option{-z} option. In this case @command{dlltool}
3810 will scan the object files specified on its command line looking for
3811 those functions which have been specially marked as being exported and
3812 put entries for them in the @file{.def} file it creates.
3814 In order to mark a function as being exported from a DLL, it needs to
3815 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3816 section of the object file. This can be done in C by using the
3820 asm (".section .drectve");
3821 asm (".ascii \"-export:my_func\"");
3823 int my_func (void) @{ @dots{} @}
3826 The second file needed for DLL creation is an exports file. This file
3827 is linked with the object files that make up the body of the DLL and it
3828 handles the interface between the DLL and the outside world. This is a
3829 binary file and it can be created by giving the @option{-e} option to
3830 @command{dlltool} when it is creating or reading in a @file{.def} file.
3832 The third file needed for DLL creation is the library file that programs
3833 will link with in order to access the functions in the DLL (an `import
3834 library'). This file can be created by giving the @option{-l} option to
3835 dlltool when it is creating or reading in a @file{.def} file.
3837 If the @option{-y} option is specified, dlltool generates a delay-import
3838 library that can be used instead of the normal import library to allow
3839 a program to link to the dll only as soon as an imported function is
3840 called for the first time. The resulting executable will need to be
3841 linked to the static delayimp library containing __delayLoadHelper2(),
3842 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
3844 @command{dlltool} builds the library file by hand, but it builds the
3845 exports file by creating temporary files containing assembler statements
3846 and then assembling these. The @option{-S} command line option can be
3847 used to specify the path to the assembler that dlltool will use,
3848 and the @option{-f} option can be used to pass specific flags to that
3849 assembler. The @option{-n} can be used to prevent dlltool from deleting
3850 these temporary assembler files when it is done, and if @option{-n} is
3851 specified twice then this will prevent dlltool from deleting the
3852 temporary object files it used to build the library.
3854 Here is an example of creating a DLL from a source file @samp{dll.c} and
3855 also creating a program (from an object file called @samp{program.o})
3860 dlltool -e exports.o -l dll.lib dll.o
3861 gcc dll.o exports.o -o dll.dll
3862 gcc program.o dll.lib -o program
3866 @command{dlltool} may also be used to query an existing import library
3867 to determine the name of the DLL to which it is associated. See the
3868 description of the @option{-I} or @option{--identify} option.
3872 @c man begin OPTIONS dlltool
3874 The command line options have the following meanings:
3878 @item -d @var{filename}
3879 @itemx --input-def @var{filename}
3880 @cindex input .def file
3881 Specifies the name of a @file{.def} file to be read in and processed.
3883 @item -b @var{filename}
3884 @itemx --base-file @var{filename}
3886 Specifies the name of a base file to be read in and processed. The
3887 contents of this file will be added to the relocation section in the
3888 exports file generated by dlltool.
3890 @item -e @var{filename}
3891 @itemx --output-exp @var{filename}
3892 Specifies the name of the export file to be created by dlltool.
3894 @item -z @var{filename}
3895 @itemx --output-def @var{filename}
3896 Specifies the name of the @file{.def} file to be created by dlltool.
3898 @item -l @var{filename}
3899 @itemx --output-lib @var{filename}
3900 Specifies the name of the library file to be created by dlltool.
3902 @item -y @var{filename}
3903 @itemx --output-delaylib @var{filename}
3904 Specifies the name of the delay-import library file to be created by dlltool.
3906 @item --export-all-symbols
3907 Treat all global and weak defined symbols found in the input object
3908 files as symbols to be exported. There is a small list of symbols which
3909 are not exported by default; see the @option{--no-default-excludes}
3910 option. You may add to the list of symbols to not export by using the
3911 @option{--exclude-symbols} option.
3913 @item --no-export-all-symbols
3914 Only export symbols explicitly listed in an input @file{.def} file or in
3915 @samp{.drectve} sections in the input object files. This is the default
3916 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3917 attributes in the source code.
3919 @item --exclude-symbols @var{list}
3920 Do not export the symbols in @var{list}. This is a list of symbol names
3921 separated by comma or colon characters. The symbol names should not
3922 contain a leading underscore. This is only meaningful when
3923 @option{--export-all-symbols} is used.
3925 @item --no-default-excludes
3926 When @option{--export-all-symbols} is used, it will by default avoid
3927 exporting certain special symbols. The current list of symbols to avoid
3928 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3929 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3930 to go ahead and export these special symbols. This is only meaningful
3931 when @option{--export-all-symbols} is used.
3934 @itemx --as @var{path}
3935 Specifies the path, including the filename, of the assembler to be used
3936 to create the exports file.
3938 @item -f @var{options}
3939 @itemx --as-flags @var{options}
3940 Specifies any specific command line options to be passed to the
3941 assembler when building the exports file. This option will work even if
3942 the @option{-S} option is not used. This option only takes one argument,
3943 and if it occurs more than once on the command line, then later
3944 occurrences will override earlier occurrences. So if it is necessary to
3945 pass multiple options to the assembler they should be enclosed in
3949 @itemx --dll-name @var{name}
3950 Specifies the name to be stored in the @file{.def} file as the name of
3951 the DLL when the @option{-e} option is used. If this option is not
3952 present, then the filename given to the @option{-e} option will be
3953 used as the name of the DLL.
3955 @item -m @var{machine}
3956 @itemx -machine @var{machine}
3957 Specifies the type of machine for which the library file should be
3958 built. @command{dlltool} has a built in default type, depending upon how
3959 it was created, but this option can be used to override that. This is
3960 normally only useful when creating DLLs for an ARM processor, when the
3961 contents of the DLL are actually encode using Thumb instructions.
3964 @itemx --add-indirect
3965 Specifies that when @command{dlltool} is creating the exports file it
3966 should add a section which allows the exported functions to be
3967 referenced without using the import library. Whatever the hell that
3971 @itemx --add-underscore
3972 Specifies that when @command{dlltool} is creating the exports file it
3973 should prepend an underscore to the names of @emph{all} exported symbols.
3975 @item --no-leading-underscore
3976 @item --leading-underscore
3977 Specifies whether standard symbol should be forced to be prefixed, or
3980 @item --add-stdcall-underscore
3981 Specifies that when @command{dlltool} is creating the exports file it
3982 should prepend an underscore to the names of exported @emph{stdcall}
3983 functions. Variable names and non-stdcall function names are not modified.
3984 This option is useful when creating GNU-compatible import libs for third
3985 party DLLs that were built with MS-Windows tools.
3989 Specifies that when @command{dlltool} is creating the exports file it
3990 should not append the string @samp{@@ <number>}. These numbers are
3991 called ordinal numbers and they represent another way of accessing the
3992 function in a DLL, other than by name.
3995 @itemx --add-stdcall-alias
3996 Specifies that when @command{dlltool} is creating the exports file it
3997 should add aliases for stdcall symbols without @samp{@@ <number>}
3998 in addition to the symbols with @samp{@@ <number>}.
4001 @itemx --ext-prefix-alias @var{prefix}
4002 Causes @command{dlltool} to create external aliases for all DLL
4003 imports with the specified prefix. The aliases are created for both
4004 external and import symbols with no leading underscore.
4008 Specifies that when @command{dlltool} is creating the exports and library
4009 files it should omit the @code{.idata4} section. This is for compatibility
4010 with certain operating systems.
4012 @item --use-nul-prefixed-import-tables
4013 Specifies that when @command{dlltool} is creating the exports and library
4014 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4015 element. This emulates old gnu import library generation of
4016 @code{dlltool}. By default this option is turned off.
4020 Specifies that when @command{dlltool} is creating the exports and library
4021 files it should omit the @code{.idata5} section. This is for compatibility
4022 with certain operating systems.
4024 @item -I @var{filename}
4025 @itemx --identify @var{filename}
4026 Specifies that @command{dlltool} should inspect the import library
4027 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4028 of the associated DLL(s). This can be performed in addition to any
4029 other operations indicated by the other options and arguments.
4030 @command{dlltool} fails if the import library does not exist or is not
4031 actually an import library. See also @option{--identify-strict}.
4033 @item --identify-strict
4034 Modifies the behavior of the @option{--identify} option, such
4035 that an error is reported if @var{filename} is associated with
4040 Specifies that @command{dlltool} should mark the objects in the library
4041 file and exports file that it produces as supporting interworking
4042 between ARM and Thumb code.
4046 Makes @command{dlltool} preserve the temporary assembler files it used to
4047 create the exports file. If this option is repeated then dlltool will
4048 also preserve the temporary object files it uses to create the library
4051 @item -t @var{prefix}
4052 @itemx --temp-prefix @var{prefix}
4053 Makes @command{dlltool} use @var{prefix} when constructing the names of
4054 temporary assembler and object files. By default, the temp file prefix
4055 is generated from the pid.
4059 Make dlltool describe what it is doing.
4063 Displays a list of command line options and then exits.
4067 Displays dlltool's version number and then exits.
4074 * def file format:: The format of the dlltool @file{.def} file
4077 @node def file format
4078 @section The format of the @command{dlltool} @file{.def} file
4080 A @file{.def} file contains any number of the following commands:
4084 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4085 The result is going to be named @var{name}@code{.exe}.
4087 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4088 The result is going to be named @var{name}@code{.dll}.
4089 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4090 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4093 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4094 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4095 Declares @var{name1} as an exported symbol from the DLL, with optional
4096 ordinal number @var{integer}, or declares @var{name1} as an alias
4097 (forward) of the function @var{external-name} in the DLL.
4098 If @var{its_name} is specified, this name is used as string in export table.
4100 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4101 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4102 If you want to use LIBRARY as name then you need to quote it.
4104 @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{]} *}
4105 Declares that @var{external-name} or the exported function whose
4106 ordinal number is @var{integer} is to be imported from the file
4107 @var{module-name}. If @var{internal-name} is specified then this is
4108 the name that the imported function will be referred to in the body of
4110 If @var{its_name} is specified, this name is used as string in import table.
4111 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4112 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4113 If you want to use LIBRARY as name then you need to quote it.
4115 @item @code{DESCRIPTION} @var{string}
4116 Puts @var{string} into the output @file{.exp} file in the
4117 @code{.rdata} section.
4119 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4120 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4121 Generates @code{--stack} or @code{--heap}
4122 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4123 section. The linker will see this and act upon it.
4125 @item @code{CODE} @var{attr} @code{+}
4126 @item @code{DATA} @var{attr} @code{+}
4127 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4128 Generates @code{--attr} @var{section-name} @var{attr} in the output
4129 @code{.drectve} section, where @var{attr} is one of @code{READ},
4130 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4131 this and act upon it.
4136 @c man begin SEEALSO dlltool
4137 The Info pages for @file{binutils}.
4144 @cindex ELF file information
4147 @c man title readelf Displays information about ELF files.
4150 @c man begin SYNOPSIS readelf
4151 readelf [@option{-a}|@option{--all}]
4152 [@option{-h}|@option{--file-header}]
4153 [@option{-l}|@option{--program-headers}|@option{--segments}]
4154 [@option{-S}|@option{--section-headers}|@option{--sections}]
4155 [@option{-g}|@option{--section-groups}]
4156 [@option{-t}|@option{--section-details}]
4157 [@option{-e}|@option{--headers}]
4158 [@option{-s}|@option{--syms}|@option{--symbols}]
4159 [@option{--dyn-syms}]
4160 [@option{-n}|@option{--notes}]
4161 [@option{-r}|@option{--relocs}]
4162 [@option{-u}|@option{--unwind}]
4163 [@option{-d}|@option{--dynamic}]
4164 [@option{-V}|@option{--version-info}]
4165 [@option{-A}|@option{--arch-specific}]
4166 [@option{-D}|@option{--use-dynamic}]
4167 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4168 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4169 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4170 [@option{-c}|@option{--archive-index}]
4171 [@option{-w[lLiaprmfFsoRt]}|
4172 @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]]
4173 [@option{--dwarf-depth=@var{n}}]
4174 [@option{--dwarf-start=@var{n}}]
4175 [@option{-I}|@option{--histogram}]
4176 [@option{-v}|@option{--version}]
4177 [@option{-W}|@option{--wide}]
4178 [@option{-H}|@option{--help}]
4179 @var{elffile}@dots{}
4183 @c man begin DESCRIPTION readelf
4185 @command{readelf} displays information about one or more ELF format object
4186 files. The options control what particular information to display.
4188 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4189 64-bit ELF files are supported, as are archives containing ELF files.
4191 This program performs a similar function to @command{objdump} but it
4192 goes into more detail and it exists independently of the @sc{bfd}
4193 library, so if there is a bug in @sc{bfd} then readelf will not be
4198 @c man begin OPTIONS readelf
4200 The long and short forms of options, shown here as alternatives, are
4201 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4207 Equivalent to specifying @option{--file-header},
4208 @option{--program-headers}, @option{--sections}, @option{--symbols},
4209 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4210 @option{--version-info}.
4213 @itemx --file-header
4214 @cindex ELF file header information
4215 Displays the information contained in the ELF header at the start of the
4219 @itemx --program-headers
4221 @cindex ELF program header information
4222 @cindex ELF segment information
4223 Displays the information contained in the file's segment headers, if it
4228 @itemx --section-headers
4229 @cindex ELF section information
4230 Displays the information contained in the file's section headers, if it
4234 @itemx --section-groups
4235 @cindex ELF section group information
4236 Displays the information contained in the file's section groups, if it
4240 @itemx --section-details
4241 @cindex ELF section information
4242 Displays the detailed section information. Implies @option{-S}.
4247 @cindex ELF symbol table information
4248 Displays the entries in symbol table section of the file, if it has one.
4251 @cindex ELF dynamic symbol table information
4252 Displays the entries in dynamic symbol table section of the file, if it
4257 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4262 Displays the contents of the NOTE segments and/or sections, if any.
4266 @cindex ELF reloc information
4267 Displays the contents of the file's relocation section, if it has one.
4271 @cindex unwind information
4272 Displays the contents of the file's unwind section, if it has one. Only
4273 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4274 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4278 @cindex ELF dynamic section information
4279 Displays the contents of the file's dynamic section, if it has one.
4282 @itemx --version-info
4283 @cindex ELF version sections information
4284 Displays the contents of the version sections in the file, it they
4288 @itemx --arch-specific
4289 Displays architecture-specific information in the file, if there
4293 @itemx --use-dynamic
4294 When displaying symbols, this option makes @command{readelf} use the
4295 symbol hash tables in the file's dynamic section, rather than the
4296 symbol table sections.
4298 @item -x <number or name>
4299 @itemx --hex-dump=<number or name>
4300 Displays the contents of the indicated section as a hexadecimal bytes.
4301 A number identifies a particular section by index in the section table;
4302 any other string identifies all sections with that name in the object file.
4304 @item -R <number or name>
4305 @itemx --relocated-dump=<number or name>
4306 Displays the contents of the indicated section as a hexadecimal
4307 bytes. A number identifies a particular section by index in the
4308 section table; any other string identifies all sections with that name
4309 in the object file. The contents of the section will be relocated
4310 before they are displayed.
4312 @item -p <number or name>
4313 @itemx --string-dump=<number or name>
4314 Displays the contents of the indicated section as printable strings.
4315 A number identifies a particular section by index in the section table;
4316 any other string identifies all sections with that name in the object file.
4319 @itemx --archive-index
4320 @cindex Archive file symbol index information
4321 Displays the file symbol index information contained in the header part
4322 of binary archives. Performs the same function as the @option{t}
4323 command to @command{ar}, but without using the BFD library. @xref{ar}.
4325 @item -w[lLiaprmfFsoRt]
4326 @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]
4327 Displays the contents of the debug sections in the file, if any are
4328 present. If one of the optional letters or words follows the switch
4329 then only data found in those specific sections will be dumped.
4331 Note that there is no single letter option to display the content of
4332 trace sections or .gdb_index.
4334 Note: the @option{=decodedline} option will display the interpreted
4335 contents of a .debug_line section whereas the @option{=rawline} option
4336 dumps the contents in a raw format.
4338 Note: the @option{=frames-interp} option will display the interpreted
4339 contents of a .debug_frame section whereas the @option{=frames} option
4340 dumps the contents in a raw format.
4342 Note: the output from the @option{=info} option can also be affected
4343 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4345 @item --dwarf-depth=@var{n}
4346 Limit the dump of the @code{.debug_info} section to @var{n} children.
4347 This is only useful with @option{--debug-dump=info}. The default is
4348 to print all DIEs; the special value 0 for @var{n} will also have this
4351 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4352 levels will not be printed. The range for @var{n} is zero-based.
4354 @item --dwarf-start=@var{n}
4355 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4356 useful with @option{--debug-dump=info}.
4358 If specified, this option will suppress printing of any header
4359 information and all DIEs before the DIE numbered @var{n}. Only
4360 siblings and children of the specified DIE will be printed.
4362 This can be used in conjunction with @option{--dwarf-depth}.
4366 Display a histogram of bucket list lengths when displaying the contents
4367 of the symbol tables.
4371 Display the version number of readelf.
4375 Don't break output lines to fit into 80 columns. By default
4376 @command{readelf} breaks section header and segment listing lines for
4377 64-bit ELF files, so that they fit into 80 columns. This option causes
4378 @command{readelf} to print each section header resp. each segment one a
4379 single line, which is far more readable on terminals wider than 80 columns.
4383 Display the command line options understood by @command{readelf}.
4390 @c man begin SEEALSO readelf
4391 objdump(1), and the Info entries for @file{binutils}.
4398 @cindex Update ELF header
4401 @c man title elfedit Update the ELF header of ELF files.
4404 @c man begin SYNOPSIS elfedit
4405 elfedit [@option{--input-mach=}@var{machine}]
4406 [@option{--input-type=}@var{type}]
4407 [@option{--input-osabi=}@var{osabi}]
4408 @option{--output-mach=}@var{machine}
4409 @option{--output-type=}@var{type}
4410 @option{--output-osabi=}@var{osabi}
4411 [@option{-v}|@option{--version}]
4412 [@option{-h}|@option{--help}]
4413 @var{elffile}@dots{}
4417 @c man begin DESCRIPTION elfedit
4419 @command{elfedit} updates the ELF header of ELF files which have
4420 the matching ELF machine and file types. The options control how and
4421 which fields in the ELF header should be updated.
4423 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4424 64-bit ELF files are supported, as are archives containing ELF files.
4427 @c man begin OPTIONS elfedit
4429 The long and short forms of options, shown here as alternatives, are
4430 equivalent. At least one of the @option{--output-mach},
4431 @option{--output-type} and @option{--output-osabi} options must be given.
4435 @item --input-mach=@var{machine}
4436 Set the matching input ELF machine type to @var{machine}. If
4437 @option{--input-mach} isn't specified, it will match any ELF
4440 The supported ELF machine types are, @var{L1OM}, @var{K1OM} and
4443 @item --output-mach=@var{machine}
4444 Change the ELF machine type in the ELF header to @var{machine}. The
4445 supported ELF machine types are the same as @option{--input-mach}.
4447 @item --input-type=@var{type}
4448 Set the matching input ELF file type to @var{type}. If
4449 @option{--input-type} isn't specified, it will match any ELF file types.
4451 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4453 @item --output-type=@var{type}
4454 Change the ELF file type in the ELF header to @var{type}. The
4455 supported ELF types are the same as @option{--input-type}.
4457 @item --input-osabi=@var{osabi}
4458 Set the matching input ELF file OSABI to @var{osabi}. If
4459 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4461 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4462 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4463 @var{Solaris}, @var{AIX}, @var{Irix},
4464 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4465 @var{NSK}, @var{AROS} and @var{FenixOS}.
4467 @item --output-osabi=@var{osabi}
4468 Change the ELF OSABI in the ELF header to @var{osabi}. The
4469 supported ELF OSABI are the same as @option{--input-osabi}.
4473 Display the version number of @command{elfedit}.
4477 Display the command line options understood by @command{elfedit}.
4484 @c man begin SEEALSO elfedit
4485 readelf(1), and the Info entries for @file{binutils}.
4489 @node Common Options
4490 @chapter Common Options
4492 The following command-line options are supported by all of the
4493 programs described in this manual.
4495 @c man begin OPTIONS
4497 @include at-file.texi
4501 Display the command-line options supported by the program.
4504 Display the version number of the program.
4506 @c man begin OPTIONS
4510 @node Selecting the Target System
4511 @chapter Selecting the Target System
4513 You can specify two aspects of the target system to the @sc{gnu}
4514 binary file utilities, each in several ways:
4524 In the following summaries, the lists of ways to specify values are in
4525 order of decreasing precedence. The ways listed first override those
4528 The commands to list valid values only list the values for which the
4529 programs you are running were configured. If they were configured with
4530 @option{--enable-targets=all}, the commands list most of the available
4531 values, but a few are left out; not all targets can be configured in at
4532 once because some of them can only be configured @dfn{native} (on hosts
4533 with the same type as the target system).
4536 * Target Selection::
4537 * Architecture Selection::
4540 @node Target Selection
4541 @section Target Selection
4543 A @dfn{target} is an object file format. A given target may be
4544 supported for multiple architectures (@pxref{Architecture Selection}).
4545 A target selection may also have variations for different operating
4546 systems or architectures.
4548 The command to list valid target values is @samp{objdump -i}
4549 (the first column of output contains the relevant information).
4551 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4552 @samp{a.out-sunos-big}.
4554 You can also specify a target using a configuration triplet. This is
4555 the same sort of name that is passed to @file{configure} to specify a
4556 target. When you use a configuration triplet as an argument, it must be
4557 fully canonicalized. You can see the canonical version of a triplet by
4558 running the shell script @file{config.sub} which is included with the
4561 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4562 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4564 @subheading @command{objdump} Target
4570 command line option: @option{-b} or @option{--target}
4573 environment variable @code{GNUTARGET}
4576 deduced from the input file
4579 @subheading @command{objcopy} and @command{strip} Input Target
4585 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4588 environment variable @code{GNUTARGET}
4591 deduced from the input file
4594 @subheading @command{objcopy} and @command{strip} Output Target
4600 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4603 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4606 environment variable @code{GNUTARGET}
4609 deduced from the input file
4612 @subheading @command{nm}, @command{size}, and @command{strings} Target
4618 command line option: @option{--target}
4621 environment variable @code{GNUTARGET}
4624 deduced from the input file
4627 @node Architecture Selection
4628 @section Architecture Selection
4630 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4631 to run. Its name may contain a colon, separating the name of the
4632 processor family from the name of the particular @sc{cpu}.
4634 The command to list valid architecture values is @samp{objdump -i} (the
4635 second column contains the relevant information).
4637 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4639 @subheading @command{objdump} Architecture
4645 command line option: @option{-m} or @option{--architecture}
4648 deduced from the input file
4651 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4657 deduced from the input file
4660 @node Reporting Bugs
4661 @chapter Reporting Bugs
4663 @cindex reporting bugs
4665 Your bug reports play an essential role in making the binary utilities
4668 Reporting a bug may help you by bringing a solution to your problem, or
4669 it may not. But in any case the principal function of a bug report is
4670 to help the entire community by making the next version of the binary
4671 utilities work better. Bug reports are your contribution to their
4674 In order for a bug report to serve its purpose, you must include the
4675 information that enables us to fix the bug.
4678 * Bug Criteria:: Have you found a bug?
4679 * Bug Reporting:: How to report bugs
4683 @section Have You Found a Bug?
4684 @cindex bug criteria
4686 If you are not sure whether you have found a bug, here are some guidelines:
4689 @cindex fatal signal
4692 If a binary utility gets a fatal signal, for any input whatever, that is
4693 a bug. Reliable utilities never crash.
4695 @cindex error on valid input
4697 If a binary utility produces an error message for valid input, that is a
4701 If you are an experienced user of binary utilities, your suggestions for
4702 improvement are welcome in any case.
4706 @section How to Report Bugs
4708 @cindex bugs, reporting
4710 A number of companies and individuals offer support for @sc{gnu}
4711 products. If you obtained the binary utilities from a support
4712 organization, we recommend you contact that organization first.
4714 You can find contact information for many support companies and
4715 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4719 In any event, we also recommend that you send bug reports for the binary
4720 utilities to @value{BUGURL}.
4723 The fundamental principle of reporting bugs usefully is this:
4724 @strong{report all the facts}. If you are not sure whether to state a
4725 fact or leave it out, state it!
4727 Often people omit facts because they think they know what causes the
4728 problem and assume that some details do not matter. Thus, you might
4729 assume that the name of a file you use in an example does not matter.
4730 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4731 a stray memory reference which happens to fetch from the location where
4732 that pathname is stored in memory; perhaps, if the pathname were
4733 different, the contents of that location would fool the utility into
4734 doing the right thing despite the bug. Play it safe and give a
4735 specific, complete example. That is the easiest thing for you to do,
4736 and the most helpful.
4738 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4739 it is new to us. Therefore, always write your bug reports on the assumption
4740 that the bug has not been reported previously.
4742 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4743 bell?'' This cannot help us fix a bug, so it is basically useless. We
4744 respond by asking for enough details to enable us to investigate.
4745 You might as well expedite matters by sending them to begin with.
4747 To enable us to fix the bug, you should include all these things:
4751 The version of the utility. Each utility announces it if you start it
4752 with the @option{--version} argument.
4754 Without this, we will not know whether there is any point in looking for
4755 the bug in the current version of the binary utilities.
4758 Any patches you may have applied to the source, including any patches
4759 made to the @code{BFD} library.
4762 The type of machine you are using, and the operating system name and
4766 What compiler (and its version) was used to compile the utilities---e.g.
4770 The command arguments you gave the utility to observe the bug. To
4771 guarantee you will not omit something important, list them all. A copy
4772 of the Makefile (or the output from make) is sufficient.
4774 If we were to try to guess the arguments, we would probably guess wrong
4775 and then we might not encounter the bug.
4778 A complete input file, or set of input files, that will reproduce the
4779 bug. If the utility is reading an object file or files, then it is
4780 generally most helpful to send the actual object files.
4782 If the source files were produced exclusively using @sc{gnu} programs
4783 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4784 may be OK to send the source files rather than the object files. In
4785 this case, be sure to say exactly what version of @command{gcc}, or
4786 whatever, was used to produce the object files. Also say how
4787 @command{gcc}, or whatever, was configured.
4790 A description of what behavior you observe that you believe is
4791 incorrect. For example, ``It gets a fatal signal.''
4793 Of course, if the bug is that the utility gets a fatal signal, then we
4794 will certainly notice it. But if the bug is incorrect output, we might
4795 not notice unless it is glaringly wrong. You might as well not give us
4796 a chance to make a mistake.
4798 Even if the problem you experience is a fatal signal, you should still
4799 say so explicitly. Suppose something strange is going on, such as your
4800 copy of the utility is out of sync, or you have encountered a bug in
4801 the C library on your system. (This has happened!) Your copy might
4802 crash and ours would not. If you told us to expect a crash, then when
4803 ours fails to crash, we would know that the bug was not happening for
4804 us. If you had not told us to expect a crash, then we would not be able
4805 to draw any conclusion from our observations.
4808 If you wish to suggest changes to the source, send us context diffs, as
4809 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4810 option. Always send diffs from the old file to the new file. If you
4811 wish to discuss something in the @command{ld} source, refer to it by
4812 context, not by line number.
4814 The line numbers in our development sources will not match those in your
4815 sources. Your line numbers would convey no useful information to us.
4818 Here are some things that are not necessary:
4822 A description of the envelope of the bug.
4824 Often people who encounter a bug spend a lot of time investigating
4825 which changes to the input file will make the bug go away and which
4826 changes will not affect it.
4828 This is often time consuming and not very useful, because the way we
4829 will find the bug is by running a single example under the debugger
4830 with breakpoints, not by pure deduction from a series of examples.
4831 We recommend that you save your time for something else.
4833 Of course, if you can find a simpler example to report @emph{instead}
4834 of the original one, that is a convenience for us. Errors in the
4835 output will be easier to spot, running under the debugger will take
4836 less time, and so on.
4838 However, simplification is not vital; if you do not want to do this,
4839 report the bug anyway and send us the entire test case you used.
4842 A patch for the bug.
4844 A patch for the bug does help us if it is a good one. But do not omit
4845 the necessary information, such as the test case, on the assumption that
4846 a patch is all we need. We might see problems with your patch and decide
4847 to fix the problem another way, or we might not understand it at all.
4849 Sometimes with programs as complicated as the binary utilities it is
4850 very hard to construct an example that will make the program follow a
4851 certain path through the code. If you do not send us the example, we
4852 will not be able to construct one, so we will not be able to verify that
4855 And if we cannot understand what bug you are trying to fix, or why your
4856 patch should be an improvement, we will not install it. A test case will
4857 help us to understand.
4860 A guess about what the bug is or what it depends on.
4862 Such guesses are usually wrong. Even we cannot guess right about such
4863 things without first using the debugger to find the facts.
4866 @node GNU Free Documentation License
4867 @appendix GNU Free Documentation License
4871 @node Binutils Index
4872 @unnumbered Binutils Index