1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
14 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
15 Free Software Foundation, Inc.
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.3
19 or any later version published by the Free Software Foundation;
20 with no Invariant Sections, with no Front-Cover Texts, and with no
21 Back-Cover Texts. A copy of the license is included in the
22 section entitled ``GNU Free Documentation License''.
27 @dircategory Software development
29 * Binutils: (binutils). The GNU binary utilities.
32 @dircategory Individual utilities
34 * addr2line: (binutils)addr2line. Convert addresses to file and line.
35 * ar: (binutils)ar. Create, modify, and extract from archives.
36 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
37 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
38 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
39 * nlmconv: (binutils)nlmconv. Converts object code into an NLM.
40 * nm: (binutils)nm. List symbols from object files.
41 * objcopy: (binutils)objcopy. Copy and translate object files.
42 * objdump: (binutils)objdump. Display information from object files.
43 * ranlib: (binutils)ranlib. Generate index to archive contents.
44 * readelf: (binutils)readelf. Display the contents of ELF format files.
45 * size: (binutils)size. List section sizes and total size.
46 * strings: (binutils)strings. List printable strings from files.
47 * strip: (binutils)strip. Discard symbols.
48 * elfedit: (binutils)elfedit. Update the ELF header of ELF files.
49 * windmc: (binutils)windmc. Generator for Windows message resources.
50 * windres: (binutils)windres. Manipulate Windows resources.
54 @title The @sc{gnu} Binary Utilities
55 @ifset VERSION_PACKAGE
56 @subtitle @value{VERSION_PACKAGE}
58 @subtitle Version @value{VERSION}
60 @subtitle @value{UPDATED}
61 @author Roland H. Pesch
62 @author Jeffrey M. Osier
63 @author Cygnus Support
67 {\parskip=0pt \hfill Cygnus Support\par \hfill
68 Texinfo \texinfoversion\par }
71 @vskip 0pt plus 1filll
80 This brief manual contains documentation for the @sc{gnu} binary
82 @ifset VERSION_PACKAGE
83 @value{VERSION_PACKAGE}
85 version @value{VERSION}:
90 Create, modify, and extract from archives
93 List symbols from object files
96 Copy and translate object files
99 Display information from object files
102 Generate index to archive contents
105 Display the contents of ELF format files.
108 List file section sizes and total size
111 List printable strings from files
117 Update the ELF header of ELF files.
120 Demangle encoded C++ symbols (on MS-DOS, this program is named
124 Convert addresses into file names and line numbers
127 Convert object code into a Netware Loadable Module
130 Manipulate Windows resources
133 Genertor for Windows message resources
136 Create the files needed to build and use Dynamic Link Libraries
140 This document is distributed under the terms of the GNU Free
141 Documentation License version 1.3. A copy of the license is included
142 in the section entitled ``GNU Free Documentation License''.
145 * ar:: Create, modify, and extract from archives
146 * nm:: List symbols from object files
147 * objcopy:: Copy and translate object files
148 * objdump:: Display information from object files
149 * ranlib:: Generate index to archive contents
150 * readelf:: Display the contents of ELF format files
151 * size:: List section sizes and total size
152 * strings:: List printable strings from files
153 * strip:: Discard symbols
154 * elfedit:: Update the ELF header of ELF files
155 * c++filt:: Filter to demangle encoded C++ symbols
156 * cxxfilt: c++filt. MS-DOS name for c++filt
157 * addr2line:: Convert addresses to file and line
158 * nlmconv:: Converts object code into an NLM
159 * windres:: Manipulate Windows resources
160 * windmc:: Generator for Windows message resources
161 * dlltool:: Create files needed to build and use DLLs
162 * Common Options:: Command-line options for all utilities
163 * Selecting the Target System:: How these utilities determine the target
164 * Reporting Bugs:: Reporting Bugs
165 * GNU Free Documentation License:: GNU Free Documentation License
166 * Binutils Index:: Binutils Index
174 @cindex collections of files
176 @c man title ar create, modify, and extract from archives
179 ar [@option{--plugin} @var{name}] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] [@option{--target} @var{bfdname}] @var{archive} [@var{member}@dots{}]
180 ar -M [ <mri-script ]
183 @c man begin DESCRIPTION ar
185 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
186 archives. An @dfn{archive} is a single file holding a collection of
187 other files in a structure that makes it possible to retrieve
188 the original individual files (called @dfn{members} of the archive).
190 The original files' contents, mode (permissions), timestamp, owner, and
191 group are preserved in the archive, and can be restored on
195 @sc{gnu} @command{ar} can maintain archives whose members have names of any
196 length; however, depending on how @command{ar} is configured on your
197 system, a limit on member-name length may be imposed for compatibility
198 with archive formats maintained with other tools. If it exists, the
199 limit is often 15 characters (typical of formats related to a.out) or 16
200 characters (typical of formats related to coff).
203 @command{ar} is considered a binary utility because archives of this sort
204 are most often used as @dfn{libraries} holding commonly needed
208 @command{ar} creates an index to the symbols defined in relocatable
209 object modules in the archive when you specify the modifier @samp{s}.
210 Once created, this index is updated in the archive whenever @command{ar}
211 makes a change to its contents (save for the @samp{q} update operation).
212 An archive with such an index speeds up linking to the library, and
213 allows routines in the library to call each other without regard to
214 their placement in the archive.
216 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
217 table. If an archive lacks the table, another form of @command{ar} called
218 @command{ranlib} can be used to add just the table.
220 @cindex thin archives
221 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
222 which contains a symbol index and references to the original copies
223 of the member files of the archives. Such an archive is useful
224 for building libraries for use within a local build, where the
225 relocatable objects are expected to remain available, and copying the
226 contents of each object would only waste time and space. Thin archives
227 are also @emph{flattened}, so that adding one or more archives to a
228 thin archive will add the elements of the nested archive individually.
229 The paths to the elements of the archive are stored relative to the
232 @cindex compatibility, @command{ar}
233 @cindex @command{ar} compatibility
234 @sc{gnu} @command{ar} is designed to be compatible with two different
235 facilities. You can control its activity using command-line options,
236 like the different varieties of @command{ar} on Unix systems; or, if you
237 specify the single command-line option @option{-M}, you can control it
238 with a script supplied via standard input, like the MRI ``librarian''
244 * ar cmdline:: Controlling @command{ar} on the command line
245 * ar scripts:: Controlling @command{ar} with a script
250 @section Controlling @command{ar} on the Command Line
253 @c man begin SYNOPSIS ar
254 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{}]
258 @cindex Unix compatibility, @command{ar}
259 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
260 arguments to execute: one keyletter specifying the @emph{operation}
261 (optionally accompanied by other keyletters specifying
262 @emph{modifiers}), and the archive name to act on.
264 Most operations can also accept further @var{member} arguments,
265 specifying particular files to operate on.
267 @c man begin OPTIONS ar
269 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
270 flags @var{mod} in any order, within the first command-line argument.
272 If you wish, you may begin the first command-line argument with a
275 @cindex operations on archive
276 The @var{p} keyletter specifies what operation to execute; it may be
277 any of the following, but you must specify only one of them:
281 @cindex deleting from archive
282 @emph{Delete} modules from the archive. Specify the names of modules to
283 be deleted as @var{member}@dots{}; the archive is untouched if you
284 specify no files to delete.
286 If you specify the @samp{v} modifier, @command{ar} lists each module
290 @cindex moving in archive
291 Use this operation to @emph{move} members in an archive.
293 The ordering of members in an archive can make a difference in how
294 programs are linked using the library, if a symbol is defined in more
297 If no modifiers are used with @code{m}, any members you name in the
298 @var{member} arguments are moved to the @emph{end} of the archive;
299 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
300 specified place instead.
303 @cindex printing from archive
304 @emph{Print} the specified members of the archive, to the standard
305 output file. If the @samp{v} modifier is specified, show the member
306 name before copying its contents to standard output.
308 If you specify no @var{member} arguments, all the files in the archive are
312 @cindex quick append to archive
313 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
314 @var{archive}, without checking for replacement.
316 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
317 operation; new members are always placed at the end of the archive.
319 The modifier @samp{v} makes @command{ar} list each file as it is appended.
321 Since the point of this operation is speed, the archive's symbol table
322 index is not updated, even if it already existed; you can use @samp{ar s} or
323 @command{ranlib} explicitly to update the symbol table index.
325 However, too many different systems assume quick append rebuilds the
326 index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
329 @cindex replacement in archive
330 Insert the files @var{member}@dots{} into @var{archive} (with
331 @emph{replacement}). This operation differs from @samp{q} in that any
332 previously existing members are deleted if their names match those being
335 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
336 displays an error message, and leaves undisturbed any existing members
337 of the archive matching that name.
339 By default, new members are added at the end of the file; but you may
340 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
341 placement relative to some existing member.
343 The modifier @samp{v} used with this operation elicits a line of
344 output for each file inserted, along with one of the letters @samp{a} or
345 @samp{r} to indicate whether the file was appended (no old member
346 deleted) or replaced.
350 Add an index to the archive, or update it if it already exists. Note
351 this command is an exception to the rule that there can only be one
352 command letter, as it is possible to use it as either a command or a
353 modifier. In either case it does the same thing.
356 @cindex contents of archive
357 Display a @emph{table} listing the contents of @var{archive}, or those
358 of the files listed in @var{member}@dots{} that are present in the
359 archive. Normally only the member name is shown; if you also want to
360 see the modes (permissions), timestamp, owner, group, and size, you can
361 request that by also specifying the @samp{v} modifier.
363 If you do not specify a @var{member}, all files in the archive
366 @cindex repeated names in archive
367 @cindex name duplication in archive
368 If there is more than one file with the same name (say, @samp{fie}) in
369 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
370 first instance; to see them all, you must ask for a complete
371 listing---in our example, @samp{ar t b.a}.
372 @c WRS only; per Gumby, this is implementation-dependent, and in a more
373 @c recent case in fact works the other way.
376 @cindex extract from archive
377 @emph{Extract} members (named @var{member}) from the archive. You can
378 use the @samp{v} modifier with this operation, to request that
379 @command{ar} list each name as it extracts it.
381 If you do not specify a @var{member}, all files in the archive
384 Files cannot be extracted from a thin archive.
387 Displays the list of command line options supported by @command{ar}
391 Displays the version information of @command{ar} and then exits.
395 A number of modifiers (@var{mod}) may immediately follow the @var{p}
396 keyletter, to specify variations on an operation's behavior:
400 @cindex relative placement in archive
401 Add new files @emph{after} an existing member of the
402 archive. If you use the modifier @samp{a}, the name of an existing archive
403 member must be present as the @var{relpos} argument, before the
404 @var{archive} specification.
407 Add new files @emph{before} an existing member of the
408 archive. If you use the modifier @samp{b}, the name of an existing archive
409 member must be present as the @var{relpos} argument, before the
410 @var{archive} specification. (same as @samp{i}).
413 @cindex creating archives
414 @emph{Create} the archive. The specified @var{archive} is always
415 created if it did not exist, when you request an update. But a warning is
416 issued unless you specify in advance that you expect to create it, by
420 @cindex deterministic archives
421 Operate in @emph{deterministic} mode. When adding files and the archive
422 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
423 for all files. When this option is used, if @command{ar} is used with
424 identical options and identical input files, multiple runs will create
425 identical output files regardless of the input files' owners, groups,
426 file modes, or modification times.
429 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
430 names of any length. This will cause it to create archives which are
431 not compatible with the native @command{ar} program on some systems. If
432 this is a concern, the @samp{f} modifier may be used to truncate file
433 names when putting them in the archive.
436 Insert new files @emph{before} an existing member of the
437 archive. If you use the modifier @samp{i}, the name of an existing archive
438 member must be present as the @var{relpos} argument, before the
439 @var{archive} specification. (same as @samp{b}).
442 This modifier is accepted but not used.
443 @c whaffor ar l modifier??? presumably compat; with
444 @c what???---doc@@cygnus.com, 25jan91
447 Uses the @var{count} parameter. This is used if there are multiple
448 entries in the archive with the same name. Extract or delete instance
449 @var{count} of the given name from the archive.
452 @cindex dates in archive
453 Preserve the @emph{original} dates of members when extracting them. If
454 you do not specify this modifier, files extracted from the archive
455 are stamped with the time of extraction.
458 Use the full path name when matching names in the archive. @sc{gnu}
459 @command{ar} can not create an archive with a full path name (such archives
460 are not POSIX complaint), but other archive creators can. This option
461 will cause @sc{gnu} @command{ar} to match file names using a complete path
462 name, which can be convenient when extracting a single file from an
463 archive created by another tool.
466 @cindex writing archive index
467 Write an object-file index into the archive, or update an existing one,
468 even if no other change is made to the archive. You may use this modifier
469 flag either with any operation, or alone. Running @samp{ar s} on an
470 archive is equivalent to running @samp{ranlib} on it.
473 @cindex not writing archive index
474 Do not generate an archive symbol table. This can speed up building a
475 large library in several steps. The resulting archive can not be used
476 with the linker. In order to build a symbol table, you must omit the
477 @samp{S} modifier on the last execution of @samp{ar}, or you must run
478 @samp{ranlib} on the archive.
481 @cindex creating thin archive
482 Make the specified @var{archive} a @emph{thin} archive. If it already
483 exists and is a regular archive, the existing members must be present
484 in the same directory as @var{archive}.
487 @cindex updating an archive
488 Normally, @samp{ar r}@dots{} inserts all files
489 listed into the archive. If you would like to insert @emph{only} those
490 of the files you list that are newer than existing members of the same
491 names, use this modifier. The @samp{u} modifier is allowed only for the
492 operation @samp{r} (replace). In particular, the combination @samp{qu} is
493 not allowed, since checking the timestamps would lose any speed
494 advantage from the operation @samp{q}.
497 This modifier requests the @emph{verbose} version of an operation. Many
498 operations display additional information, such as filenames processed,
499 when the modifier @samp{v} is appended.
502 This modifier shows the version number of @command{ar}.
505 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
506 compatibility with AIX. The behaviour produced by this option is the
507 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
508 @samp{-X} options; in particular, it does not support @option{-X32}
509 which is the default for AIX @command{ar}.
511 The optional command line switch @option{--plugin} @var{name} causes
512 @command{ar} to load the plugin called @var{name} which adds support
513 for more file formats. This option is only available if the toolchain
514 has been built with plugin support enabled.
516 The optional command line switch @option{--target} @var{bfdname}
517 specifies that the archive members are in an object code format
518 different from your system's default format. See
519 @xref{Target Selection}, for more information.
524 @c man begin SEEALSO ar
525 nm(1), ranlib(1), and the Info entries for @file{binutils}.
530 @section Controlling @command{ar} with a Script
533 ar -M [ <@var{script} ]
536 @cindex MRI compatibility, @command{ar}
537 @cindex scripts, @command{ar}
538 If you use the single command-line option @samp{-M} with @command{ar}, you
539 can control its operation with a rudimentary command language. This
540 form of @command{ar} operates interactively if standard input is coming
541 directly from a terminal. During interactive use, @command{ar} prompts for
542 input (the prompt is @samp{AR >}), and continues executing even after
543 errors. If you redirect standard input to a script file, no prompts are
544 issued, and @command{ar} abandons execution (with a nonzero exit code)
547 The @command{ar} command language is @emph{not} designed to be equivalent
548 to the command-line options; in fact, it provides somewhat less control
549 over archives. The only purpose of the command language is to ease the
550 transition to @sc{gnu} @command{ar} for developers who already have scripts
551 written for the MRI ``librarian'' program.
553 The syntax for the @command{ar} command language is straightforward:
556 commands are recognized in upper or lower case; for example, @code{LIST}
557 is the same as @code{list}. In the following descriptions, commands are
558 shown in upper case for clarity.
561 a single command may appear on each line; it is the first word on the
565 empty lines are allowed, and have no effect.
568 comments are allowed; text after either of the characters @samp{*}
569 or @samp{;} is ignored.
572 Whenever you use a list of names as part of the argument to an @command{ar}
573 command, you can separate the individual names with either commas or
574 blanks. Commas are shown in the explanations below, for clarity.
577 @samp{+} is used as a line continuation character; if @samp{+} appears
578 at the end of a line, the text on the following line is considered part
579 of the current command.
582 Here are the commands you can use in @command{ar} scripts, or when using
583 @command{ar} interactively. Three of them have special significance:
585 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
586 a temporary file required for most of the other commands.
588 @code{SAVE} commits the changes so far specified by the script. Prior
589 to @code{SAVE}, commands affect only the temporary copy of the current
593 @item ADDLIB @var{archive}
594 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
595 Add all the contents of @var{archive} (or, if specified, each named
596 @var{module} from @var{archive}) to the current archive.
598 Requires prior use of @code{OPEN} or @code{CREATE}.
600 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
601 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
602 @c else like "ar q..."
603 Add each named @var{member} as a module in the current archive.
605 Requires prior use of @code{OPEN} or @code{CREATE}.
608 Discard the contents of the current archive, canceling the effect of
609 any operations since the last @code{SAVE}. May be executed (with no
610 effect) even if no current archive is specified.
612 @item CREATE @var{archive}
613 Creates an archive, and makes it the current archive (required for many
614 other commands). The new archive is created with a temporary name; it
615 is not actually saved as @var{archive} until you use @code{SAVE}.
616 You can overwrite existing archives; similarly, the contents of any
617 existing file named @var{archive} will not be destroyed until @code{SAVE}.
619 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
620 Delete each listed @var{module} from the current archive; equivalent to
621 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
623 Requires prior use of @code{OPEN} or @code{CREATE}.
625 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
626 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
627 List each named @var{module} present in @var{archive}. The separate
628 command @code{VERBOSE} specifies the form of the output: when verbose
629 output is off, output is like that of @samp{ar -t @var{archive}
630 @var{module}@dots{}}. When verbose output is on, the listing is like
631 @samp{ar -tv @var{archive} @var{module}@dots{}}.
633 Output normally goes to the standard output stream; however, if you
634 specify @var{outputfile} as a final argument, @command{ar} directs the
638 Exit from @command{ar}, with a @code{0} exit code to indicate successful
639 completion. This command does not save the output file; if you have
640 changed the current archive since the last @code{SAVE} command, those
643 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
644 Extract each named @var{module} from the current archive, writing them
645 into the current directory as separate files. Equivalent to @samp{ar -x
646 @var{archive} @var{module}@dots{}}.
648 Requires prior use of @code{OPEN} or @code{CREATE}.
651 @c FIXME Tokens but no commands???
658 Display full contents of the current archive, in ``verbose'' style
659 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
660 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
661 enhancement, rather than present for MRI compatibility.)
663 Requires prior use of @code{OPEN} or @code{CREATE}.
665 @item OPEN @var{archive}
666 Opens an existing archive for use as the current archive (required for
667 many other commands). Any changes as the result of subsequent commands
668 will not actually affect @var{archive} until you next use @code{SAVE}.
670 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
671 In the current archive, replace each existing @var{module} (named in
672 the @code{REPLACE} arguments) from files in the current working directory.
673 To execute this command without errors, both the file, and the module in
674 the current archive, must exist.
676 Requires prior use of @code{OPEN} or @code{CREATE}.
679 Toggle an internal flag governing the output from @code{DIRECTORY}.
680 When the flag is on, @code{DIRECTORY} output matches output from
681 @samp{ar -tv }@dots{}.
684 Commit your changes to the current archive, and actually save it as a
685 file with the name specified in the last @code{CREATE} or @code{OPEN}
688 Requires prior use of @code{OPEN} or @code{CREATE}.
697 The @sc{gnu} linker @command{ld} is now described in a separate manual.
698 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
706 @c man title nm list symbols from object files
709 @c man begin SYNOPSIS nm
710 nm [@option{-a}|@option{--debug-syms}]
711 [@option{-g}|@option{--extern-only}][@option{--plugin} @var{name}]
712 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
713 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
714 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
715 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
716 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
717 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
718 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
719 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
720 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
724 @c man begin DESCRIPTION nm
725 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
726 If no object files are listed as arguments, @command{nm} assumes the file
729 For each symbol, @command{nm} shows:
733 The symbol value, in the radix selected by options (see below), or
734 hexadecimal by default.
737 The symbol type. At least the following types are used; others are, as
738 well, depending on the object file format. If lowercase, the symbol is
739 usually local; if uppercase, the symbol is global (external). There
740 are however a few lowercase symbols that are shown for special global
741 symbols (@code{u}, @code{v} and @code{w}).
743 @c Some more detail on exactly what these symbol types are used for
747 The symbol's value is absolute, and will not be changed by further
752 The symbol is in the uninitialized data section (known as BSS).
755 The symbol is common. Common symbols are uninitialized data. When
756 linking, multiple common symbols may appear with the same name. If the
757 symbol is defined anywhere, the common symbols are treated as undefined
760 For more details on common symbols, see the discussion of
761 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
766 The symbol is in the initialized data section.
770 The symbol is in an initialized data section for small objects. Some
771 object file formats permit more efficient access to small data objects,
772 such as a global int variable as opposed to a large global array.
775 For PE format files this indicates that the symbol is in a section
776 specific to the implementation of DLLs. For ELF format files this
777 indicates that the symbol is an indirect function. This is a GNU
778 extension to the standard set of ELF symbol types. It indicates a
779 symbol which if referenced by a relocation does not evaluate to its
780 address, but instead must be invoked at runtime. The runtime
781 execution will then return the value to be used in the relocation.
784 The symbol is a debugging symbol.
787 The symbols is in a stack unwind section.
791 The symbol is in a read only data section.
795 The symbol is in an uninitialized data section for small objects.
799 The symbol is in the text (code) section.
802 The symbol is undefined.
805 The symbol is a unique global symbol. This is a GNU extension to the
806 standard set of ELF symbol bindings. For such a symbol the dynamic linker
807 will make sure that in the entire process there is just one symbol with
808 this name and type in use.
812 The symbol is a weak object. When a weak defined symbol is linked with
813 a normal defined symbol, the normal defined symbol is used with no error.
814 When a weak undefined symbol is linked and the symbol is not defined,
815 the value of the weak symbol becomes zero with no error. On some
816 systems, uppercase indicates that a default value has been specified.
820 The symbol is a weak symbol that has not been specifically tagged as a
821 weak object symbol. When a weak defined symbol is linked with a normal
822 defined symbol, the normal defined symbol is used with no error.
823 When a weak undefined symbol is linked and the symbol is not defined,
824 the value of the symbol is determined in a system-specific manner without
825 error. On some systems, uppercase indicates that a default value has been
829 The symbol is a stabs symbol in an a.out object file. In this case, the
830 next values printed are the stabs other field, the stabs desc field, and
831 the stab type. Stabs symbols are used to hold debugging information.
833 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
834 ``stabs'' debug format}.
838 The symbol type is unknown, or object file format specific.
847 @c man begin OPTIONS nm
848 The long and short forms of options, shown here as alternatives, are
854 @itemx --print-file-name
855 @cindex input file name
857 @cindex source file name
858 Precede each symbol by the name of the input file (or archive member)
859 in which it was found, rather than identifying the input file once only,
860 before all of its symbols.
864 @cindex debugging symbols
865 Display all symbols, even debugger-only symbols; normally these are not
869 @cindex @command{nm} format
870 @cindex @command{nm} compatibility
871 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
874 @itemx --demangle[=@var{style}]
875 @cindex demangling in nm
876 Decode (@dfn{demangle}) low-level symbol names into user-level names.
877 Besides removing any initial underscore prepended by the system, this
878 makes C++ function names readable. Different compilers have different
879 mangling styles. The optional demangling style argument can be used to
880 choose an appropriate demangling style for your compiler. @xref{c++filt},
881 for more information on demangling.
884 Do not demangle low-level symbol names. This is the default.
888 @cindex dynamic symbols
889 Display the dynamic symbols rather than the normal symbols. This is
890 only meaningful for dynamic objects, such as certain types of shared
893 @item -f @var{format}
894 @itemx --format=@var{format}
895 @cindex @command{nm} format
896 @cindex @command{nm} compatibility
897 Use the output format @var{format}, which can be @code{bsd},
898 @code{sysv}, or @code{posix}. The default is @code{bsd}.
899 Only the first character of @var{format} is significant; it can be
900 either upper or lower case.
904 @cindex external symbols
905 Display only external symbols.
907 @item --plugin @var{name}
909 Load the plugin called @var{name} to add support for extra target
910 types. This option is only available if the toolchain has been built
911 with plugin support enabled.
914 @itemx --line-numbers
915 @cindex symbol line numbers
916 For each symbol, use debugging information to try to find a filename and
917 line number. For a defined symbol, look for the line number of the
918 address of the symbol. For an undefined symbol, look for the line
919 number of a relocation entry which refers to the symbol. If line number
920 information can be found, print it after the other symbol information.
924 @itemx --numeric-sort
925 Sort symbols numerically by their addresses, rather than alphabetically
930 @cindex sorting symbols
931 Do not bother to sort the symbols in any order; print them in the order
936 Use the POSIX.2 standard output format instead of the default format.
937 Equivalent to @samp{-f posix}.
941 Print both value and size of defined symbols for the @code{bsd} output style.
942 This option has no effect for object formats that do not record symbol
943 sizes, unless @samp{--size-sort} is also used in which case a
944 calculated size is displayed.
948 @cindex symbol index, listing
949 When listing symbols from archive members, include the index: a mapping
950 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
951 contain definitions for which names.
954 @itemx --reverse-sort
955 Reverse the order of the sort (whether numeric or alphabetic); let the
959 Sort symbols by size. The size is computed as the difference between
960 the value of the symbol and the value of the symbol with the next higher
961 value. If the @code{bsd} output format is used the size of the symbol
962 is printed, rather than the value, and @samp{-S} must be used in order
963 both size and value to be printed.
966 Display symbols which have a target-specific special meaning. These
967 symbols are usually used by the target for some special processing and
968 are not normally helpful when included included in the normal symbol
969 lists. For example for ARM targets this option would skip the mapping
970 symbols used to mark transitions between ARM code, THUMB code and
974 @itemx --radix=@var{radix}
975 Use @var{radix} as the radix for printing the symbol values. It must be
976 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
978 @item --target=@var{bfdname}
979 @cindex object code format
980 Specify an object code format other than your system's default format.
981 @xref{Target Selection}, for more information.
984 @itemx --undefined-only
985 @cindex external symbols
986 @cindex undefined symbols
987 Display only undefined symbols (those external to each object file).
990 @cindex external symbols
991 @cindex undefined symbols
992 Display only defined symbols for each object file.
996 Show the version number of @command{nm} and exit.
999 This option is ignored for compatibility with the AIX version of
1000 @command{nm}. It takes one parameter which must be the string
1001 @option{32_64}. The default mode of AIX @command{nm} corresponds
1002 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1005 Show a summary of the options to @command{nm} and exit.
1011 @c man begin SEEALSO nm
1012 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1019 @c man title objcopy copy and translate object files
1022 @c man begin SYNOPSIS objcopy
1023 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1024 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1025 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1026 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1027 [@option{-S}|@option{--strip-all}]
1028 [@option{-g}|@option{--strip-debug}]
1029 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1030 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1031 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1032 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1033 [@option{--localize-hidden}]
1034 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1035 [@option{--globalize-symbol=}@var{symbolname}]
1036 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1037 [@option{-w}|@option{--wildcard}]
1038 [@option{-x}|@option{--discard-all}]
1039 [@option{-X}|@option{--discard-locals}]
1040 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1041 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1042 [@option{--interleave-width=}@var{width}]
1043 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
1044 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
1045 [@option{-p}|@option{--preserve-dates}]
1046 [@option{--debugging}]
1047 [@option{--gap-fill=}@var{val}]
1048 [@option{--pad-to=}@var{address}]
1049 [@option{--set-start=}@var{val}]
1050 [@option{--adjust-start=}@var{incr}]
1051 [@option{--change-addresses=}@var{incr}]
1052 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
1053 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
1054 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
1055 [@option{--change-warnings}] [@option{--no-change-warnings}]
1056 [@option{--set-section-flags} @var{section}=@var{flags}]
1057 [@option{--add-section} @var{sectionname}=@var{filename}]
1058 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1059 [@option{--long-section-names} @{enable,disable,keep@}]
1060 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1061 [@option{--reverse-bytes=}@var{num}]
1062 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1063 [@option{--redefine-sym} @var{old}=@var{new}]
1064 [@option{--redefine-syms=}@var{filename}]
1066 [@option{--keep-symbols=}@var{filename}]
1067 [@option{--strip-symbols=}@var{filename}]
1068 [@option{--strip-unneeded-symbols=}@var{filename}]
1069 [@option{--keep-global-symbols=}@var{filename}]
1070 [@option{--localize-symbols=}@var{filename}]
1071 [@option{--globalize-symbols=}@var{filename}]
1072 [@option{--weaken-symbols=}@var{filename}]
1073 [@option{--alt-machine-code=}@var{index}]
1074 [@option{--prefix-symbols=}@var{string}]
1075 [@option{--prefix-sections=}@var{string}]
1076 [@option{--prefix-alloc-sections=}@var{string}]
1077 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1078 [@option{--keep-file-symbols}]
1079 [@option{--only-keep-debug}]
1080 [@option{--extract-symbol}]
1081 [@option{--writable-text}]
1082 [@option{--readonly-text}]
1085 [@option{--file-alignment=}@var{num}]
1086 [@option{--heap=}@var{size}]
1087 [@option{--image-base=}@var{address}]
1088 [@option{--section-alignment=}@var{num}]
1089 [@option{--stack=}@var{size}]
1090 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1091 [@option{--compress-debug-sections}]
1092 [@option{--decompress-debug-sections}]
1093 [@option{--dwarf-depth=@var{n}}]
1094 [@option{--dwarf-start=@var{n}}]
1095 [@option{-v}|@option{--verbose}]
1096 [@option{-V}|@option{--version}]
1097 [@option{--help}] [@option{--info}]
1098 @var{infile} [@var{outfile}]
1102 @c man begin DESCRIPTION objcopy
1103 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1104 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1105 read and write the object files. It can write the destination object
1106 file in a format different from that of the source object file. The
1107 exact behavior of @command{objcopy} is controlled by command-line options.
1108 Note that @command{objcopy} should be able to copy a fully linked file
1109 between any two formats. However, copying a relocatable object file
1110 between any two formats may not work as expected.
1112 @command{objcopy} creates temporary files to do its translations and
1113 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1114 translation work; it has access to all the formats described in @sc{bfd}
1115 and thus is able to recognize most formats without being told
1116 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1118 @command{objcopy} can be used to generate S-records by using an output
1119 target of @samp{srec} (e.g., use @samp{-O srec}).
1121 @command{objcopy} can be used to generate a raw binary file by using an
1122 output target of @samp{binary} (e.g., use @option{-O binary}). When
1123 @command{objcopy} generates a raw binary file, it will essentially produce
1124 a memory dump of the contents of the input object file. All symbols and
1125 relocation information will be discarded. The memory dump will start at
1126 the load address of the lowest section copied into the output file.
1128 When generating an S-record or a raw binary file, it may be helpful to
1129 use @option{-S} to remove sections containing debugging information. In
1130 some cases @option{-R} will be useful to remove sections which contain
1131 information that is not needed by the binary file.
1133 Note---@command{objcopy} is not able to change the endianness of its input
1134 files. If the input format has an endianness (some formats do not),
1135 @command{objcopy} can only copy the inputs into file formats that have the
1136 same endianness or which have no endianness (e.g., @samp{srec}).
1137 (However, see the @option{--reverse-bytes} option.)
1141 @c man begin OPTIONS objcopy
1145 @itemx @var{outfile}
1146 The input and output files, respectively.
1147 If you do not specify @var{outfile}, @command{objcopy} creates a
1148 temporary file and destructively renames the result with
1149 the name of @var{infile}.
1151 @item -I @var{bfdname}
1152 @itemx --input-target=@var{bfdname}
1153 Consider the source file's object format to be @var{bfdname}, rather than
1154 attempting to deduce it. @xref{Target Selection}, for more information.
1156 @item -O @var{bfdname}
1157 @itemx --output-target=@var{bfdname}
1158 Write the output file using the object format @var{bfdname}.
1159 @xref{Target Selection}, for more information.
1161 @item -F @var{bfdname}
1162 @itemx --target=@var{bfdname}
1163 Use @var{bfdname} as the object format for both the input and the output
1164 file; i.e., simply transfer data from source to destination with no
1165 translation. @xref{Target Selection}, for more information.
1167 @item -B @var{bfdarch}
1168 @itemx --binary-architecture=@var{bfdarch}
1169 Useful when transforming a architecture-less input file into an object file.
1170 In this case the output architecture can be set to @var{bfdarch}. This
1171 option will be ignored if the input file has a known @var{bfdarch}. You
1172 can access this binary data inside a program by referencing the special
1173 symbols that are created by the conversion process. These symbols are
1174 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1175 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1176 an object file and then access it in your code using these symbols.
1178 @item -j @var{sectionname}
1179 @itemx --only-section=@var{sectionname}
1180 Copy only the named section from the input file to the output file.
1181 This option may be given more than once. Note that using this option
1182 inappropriately may make the output file unusable.
1184 @item -R @var{sectionname}
1185 @itemx --remove-section=@var{sectionname}
1186 Remove any section named @var{sectionname} from the output file. This
1187 option may be given more than once. Note that using this option
1188 inappropriately may make the output file unusable.
1192 Do not copy relocation and symbol information from the source file.
1195 @itemx --strip-debug
1196 Do not copy debugging symbols or sections from the source file.
1198 @item --strip-unneeded
1199 Strip all symbols that are not needed for relocation processing.
1201 @item -K @var{symbolname}
1202 @itemx --keep-symbol=@var{symbolname}
1203 When stripping symbols, keep symbol @var{symbolname} even if it would
1204 normally be stripped. This option may be given more than once.
1206 @item -N @var{symbolname}
1207 @itemx --strip-symbol=@var{symbolname}
1208 Do not copy symbol @var{symbolname} from the source file. This option
1209 may be given more than once.
1211 @item --strip-unneeded-symbol=@var{symbolname}
1212 Do not copy symbol @var{symbolname} from the source file unless it is needed
1213 by a relocation. This option may be given more than once.
1215 @item -G @var{symbolname}
1216 @itemx --keep-global-symbol=@var{symbolname}
1217 Keep only symbol @var{symbolname} global. Make all other symbols local
1218 to the file, so that they are not visible externally. This option may
1219 be given more than once.
1221 @item --localize-hidden
1222 In an ELF object, mark all symbols that have hidden or internal visibility
1223 as local. This option applies on top of symbol-specific localization options
1224 such as @option{-L}.
1226 @item -L @var{symbolname}
1227 @itemx --localize-symbol=@var{symbolname}
1228 Make symbol @var{symbolname} local to the file, so that it is not
1229 visible externally. This option may be given more than once.
1231 @item -W @var{symbolname}
1232 @itemx --weaken-symbol=@var{symbolname}
1233 Make symbol @var{symbolname} weak. This option may be given more than once.
1235 @item --globalize-symbol=@var{symbolname}
1236 Give symbol @var{symbolname} global scoping so that it is visible
1237 outside of the file in which it is defined. This option may be given
1242 Permit regular expressions in @var{symbolname}s used in other command
1243 line options. The question mark (?), asterisk (*), backslash (\) and
1244 square brackets ([]) operators can be used anywhere in the symbol
1245 name. If the first character of the symbol name is the exclamation
1246 point (!) then the sense of the switch is reversed for that symbol.
1253 would cause objcopy to weaken all symbols that start with ``fo''
1254 except for the symbol ``foo''.
1257 @itemx --discard-all
1258 Do not copy non-global symbols from the source file.
1259 @c FIXME any reason to prefer "non-global" to "local" here?
1262 @itemx --discard-locals
1263 Do not copy compiler-generated local symbols.
1264 (These usually start with @samp{L} or @samp{.}.)
1267 @itemx --byte=@var{byte}
1268 If interleaving has been enabled via the @option{--interleave} option
1269 then start the range of bytes to keep at the @var{byte}th byte.
1270 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1271 @var{breadth} is the value given by the @option{--interleave} option.
1273 @item -i [@var{breadth}]
1274 @itemx --interleave[=@var{breadth}]
1275 Only copy a range out of every @var{breadth} bytes. (Header data is
1276 not affected). Select which byte in the range begins the copy with
1277 the @option{--byte} option. Select the width of the range with the
1278 @option{--interleave-width} option.
1280 This option is useful for creating files to program @sc{rom}. It is
1281 typically used with an @code{srec} output target. Note that
1282 @command{objcopy} will complain if you do not specify the
1283 @option{--byte} option as well.
1285 The default interleave breadth is 4, so with @option{--byte} set to 0,
1286 @command{objcopy} would copy the first byte out of every four bytes
1287 from the input to the output.
1289 @item --interleave-width=@var{width}
1290 When used with the @option{--interleave} option, copy @var{width}
1291 bytes at a time. The start of the range of bytes to be copied is set
1292 by the @option{--byte} option, and the extent of the range is set with
1293 the @option{--interleave} option.
1295 The default value for this option is 1. The value of @var{width} plus
1296 the @var{byte} value set by the @option{--byte} option must not exceed
1297 the interleave breadth set by the @option{--interleave} option.
1299 This option can be used to create images for two 16-bit flashes interleaved
1300 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1301 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1302 commands. If the input was '12345678' then the outputs would be
1303 '1256' and '3478' respectively.
1306 @itemx --preserve-dates
1307 Set the access and modification dates of the output file to be the same
1308 as those of the input file.
1311 Convert debugging information, if possible. This is not the default
1312 because only certain debugging formats are supported, and the
1313 conversion process can be time consuming.
1315 @item --gap-fill @var{val}
1316 Fill gaps between sections with @var{val}. This operation applies to
1317 the @emph{load address} (LMA) of the sections. It is done by increasing
1318 the size of the section with the lower address, and filling in the extra
1319 space created with @var{val}.
1321 @item --pad-to @var{address}
1322 Pad the output file up to the load address @var{address}. This is
1323 done by increasing the size of the last section. The extra space is
1324 filled in with the value specified by @option{--gap-fill} (default zero).
1326 @item --set-start @var{val}
1327 Set the start address of the new file to @var{val}. Not all object file
1328 formats support setting the start address.
1330 @item --change-start @var{incr}
1331 @itemx --adjust-start @var{incr}
1332 @cindex changing start address
1333 Change the start address by adding @var{incr}. Not all object file
1334 formats support setting the start address.
1336 @item --change-addresses @var{incr}
1337 @itemx --adjust-vma @var{incr}
1338 @cindex changing object addresses
1339 Change the VMA and LMA addresses of all sections, as well as the start
1340 address, by adding @var{incr}. Some object file formats do not permit
1341 section addresses to be changed arbitrarily. Note that this does not
1342 relocate the sections; if the program expects sections to be loaded at a
1343 certain address, and this option is used to change the sections such
1344 that they are loaded at a different address, the program may fail.
1346 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1347 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1348 @cindex changing section address
1349 Set or change both the VMA address and the LMA address of the named
1350 @var{section}. If @samp{=} is used, the section address is set to
1351 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1352 section address. See the comments under @option{--change-addresses},
1353 above. If @var{section} does not exist in the input file, a warning will
1354 be issued, unless @option{--no-change-warnings} is used.
1356 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1357 @cindex changing section LMA
1358 Set or change the LMA address of the named @var{section}. The LMA
1359 address is the address where the section will be loaded into memory at
1360 program load time. Normally this is the same as the VMA address, which
1361 is the address of the section at program run time, but on some systems,
1362 especially those where a program is held in ROM, the two can be
1363 different. If @samp{=} is used, the section address is set to
1364 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1365 section address. See the comments under @option{--change-addresses},
1366 above. If @var{section} does not exist in the input file, a warning
1367 will be issued, unless @option{--no-change-warnings} is used.
1369 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1370 @cindex changing section VMA
1371 Set or change the VMA address of the named @var{section}. The VMA
1372 address is the address where the section will be located once the
1373 program has started executing. Normally this is the same as the LMA
1374 address, which is the address where the section will be loaded into
1375 memory, but on some systems, especially those where a program is held in
1376 ROM, the two can be different. If @samp{=} is used, the section address
1377 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1378 from the section address. See the comments under
1379 @option{--change-addresses}, above. If @var{section} does not exist in
1380 the input file, a warning will be issued, unless
1381 @option{--no-change-warnings} is used.
1383 @item --change-warnings
1384 @itemx --adjust-warnings
1385 If @option{--change-section-address} or @option{--change-section-lma} or
1386 @option{--change-section-vma} is used, and the named section does not
1387 exist, issue a warning. This is the default.
1389 @item --no-change-warnings
1390 @itemx --no-adjust-warnings
1391 Do not issue a warning if @option{--change-section-address} or
1392 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1393 if the named section does not exist.
1395 @item --set-section-flags @var{section}=@var{flags}
1396 Set the flags for the named section. The @var{flags} argument is a
1397 comma separated string of flag names. The recognized names are
1398 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1399 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1400 @samp{debug}. You can set the @samp{contents} flag for a section which
1401 does not have contents, but it is not meaningful to clear the
1402 @samp{contents} flag of a section which does have contents--just remove
1403 the section instead. Not all flags are meaningful for all object file
1406 @item --add-section @var{sectionname}=@var{filename}
1407 Add a new section named @var{sectionname} while copying the file. The
1408 contents of the new section are taken from the file @var{filename}. The
1409 size of the section will be the size of the file. This option only
1410 works on file formats which can support sections with arbitrary names.
1412 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1413 Rename a section from @var{oldname} to @var{newname}, optionally
1414 changing the section's flags to @var{flags} in the process. This has
1415 the advantage over usng a linker script to perform the rename in that
1416 the output stays as an object file and does not become a linked
1419 This option is particularly helpful when the input format is binary,
1420 since this will always create a section called .data. If for example,
1421 you wanted instead to create a section called .rodata containing binary
1422 data you could use the following command line to achieve it:
1425 objcopy -I binary -O <output_format> -B <architecture> \
1426 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1427 <input_binary_file> <output_object_file>
1430 @item --long-section-names @{enable,disable,keep@}
1431 Controls the handling of long section names when processing @code{COFF}
1432 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1433 is to preserve long section names if any are present in the input file.
1434 The @samp{enable} and @samp{disable} options forcibly enable or disable
1435 the use of long section names in the output object; when @samp{disable}
1436 is in effect, any long section names in the input object will be truncated.
1437 The @samp{enable} option will only emit long section names if any are
1438 present in the inputs; this is mostly the same as @samp{keep}, but it
1439 is left undefined whether the @samp{enable} option might force the
1440 creation of an empty string table in the output file.
1442 @item --change-leading-char
1443 Some object file formats use special characters at the start of
1444 symbols. The most common such character is underscore, which compilers
1445 often add before every symbol. This option tells @command{objcopy} to
1446 change the leading character of every symbol when it converts between
1447 object file formats. If the object file formats use the same leading
1448 character, this option has no effect. Otherwise, it will add a
1449 character, or remove a character, or change a character, as
1452 @item --remove-leading-char
1453 If the first character of a global symbol is a special symbol leading
1454 character used by the object file format, remove the character. The
1455 most common symbol leading character is underscore. This option will
1456 remove a leading underscore from all global symbols. This can be useful
1457 if you want to link together objects of different file formats with
1458 different conventions for symbol names. This is different from
1459 @option{--change-leading-char} because it always changes the symbol name
1460 when appropriate, regardless of the object file format of the output
1463 @item --reverse-bytes=@var{num}
1464 Reverse the bytes in a section with output contents. A section length must
1465 be evenly divisible by the value given in order for the swap to be able to
1466 take place. Reversing takes place before the interleaving is performed.
1468 This option is used typically in generating ROM images for problematic
1469 target systems. For example, on some target boards, the 32-bit words
1470 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1471 regardless of the CPU byte order. Depending on the programming model, the
1472 endianness of the ROM may need to be modified.
1474 Consider a simple file with a section containing the following eight
1475 bytes: @code{12345678}.
1477 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1478 output file would be ordered @code{21436587}.
1480 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1481 output file would be ordered @code{43218765}.
1483 By using @samp{--reverse-bytes=2} for the above example, followed by
1484 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1485 output file would be ordered @code{34127856}.
1487 @item --srec-len=@var{ival}
1488 Meaningful only for srec output. Set the maximum length of the Srecords
1489 being produced to @var{ival}. This length covers both address, data and
1492 @item --srec-forceS3
1493 Meaningful only for srec output. Avoid generation of S1/S2 records,
1494 creating S3-only record format.
1496 @item --redefine-sym @var{old}=@var{new}
1497 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1498 when one is trying link two things together for which you have no
1499 source, and there are name collisions.
1501 @item --redefine-syms=@var{filename}
1502 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1503 listed in the file @var{filename}. @var{filename} is simply a flat file,
1504 with one symbol pair per line. Line comments may be introduced by the hash
1505 character. This option may be given more than once.
1508 Change all global symbols in the file to be weak. This can be useful
1509 when building an object which will be linked against other objects using
1510 the @option{-R} option to the linker. This option is only effective when
1511 using an object file format which supports weak symbols.
1513 @item --keep-symbols=@var{filename}
1514 Apply @option{--keep-symbol} option to each symbol listed in the file
1515 @var{filename}. @var{filename} is simply a flat file, with one symbol
1516 name per line. Line comments may be introduced by the hash character.
1517 This option may be given more than once.
1519 @item --strip-symbols=@var{filename}
1520 Apply @option{--strip-symbol} option to each symbol listed in the file
1521 @var{filename}. @var{filename} is simply a flat file, with one symbol
1522 name per line. Line comments may be introduced by the hash character.
1523 This option may be given more than once.
1525 @item --strip-unneeded-symbols=@var{filename}
1526 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1527 the file @var{filename}. @var{filename} is simply a flat file, with one
1528 symbol name per line. Line comments may be introduced by the hash
1529 character. This option may be given more than once.
1531 @item --keep-global-symbols=@var{filename}
1532 Apply @option{--keep-global-symbol} option to each symbol listed in the
1533 file @var{filename}. @var{filename} is simply a flat file, with one
1534 symbol name per line. Line comments may be introduced by the hash
1535 character. This option may be given more than once.
1537 @item --localize-symbols=@var{filename}
1538 Apply @option{--localize-symbol} option to each symbol listed in the file
1539 @var{filename}. @var{filename} is simply a flat file, with one symbol
1540 name per line. Line comments may be introduced by the hash character.
1541 This option may be given more than once.
1543 @item --globalize-symbols=@var{filename}
1544 Apply @option{--globalize-symbol} option to each symbol listed in the file
1545 @var{filename}. @var{filename} is simply a flat file, with one symbol
1546 name per line. Line comments may be introduced by the hash character.
1547 This option may be given more than once.
1549 @item --weaken-symbols=@var{filename}
1550 Apply @option{--weaken-symbol} option to each symbol listed in the file
1551 @var{filename}. @var{filename} is simply a flat file, with one symbol
1552 name per line. Line comments may be introduced by the hash character.
1553 This option may be given more than once.
1555 @item --alt-machine-code=@var{index}
1556 If the output architecture has alternate machine codes, use the
1557 @var{index}th code instead of the default one. This is useful in case
1558 a machine is assigned an official code and the tool-chain adopts the
1559 new code, but other applications still depend on the original code
1560 being used. For ELF based architectures if the @var{index}
1561 alternative does not exist then the value is treated as an absolute
1562 number to be stored in the e_machine field of the ELF header.
1564 @item --writable-text
1565 Mark the output text as writable. This option isn't meaningful for all
1566 object file formats.
1568 @item --readonly-text
1569 Make the output text write protected. This option isn't meaningful for all
1570 object file formats.
1573 Mark the output file as demand paged. This option isn't meaningful for all
1574 object file formats.
1577 Mark the output file as impure. This option isn't meaningful for all
1578 object file formats.
1580 @item --prefix-symbols=@var{string}
1581 Prefix all symbols in the output file with @var{string}.
1583 @item --prefix-sections=@var{string}
1584 Prefix all section names in the output file with @var{string}.
1586 @item --prefix-alloc-sections=@var{string}
1587 Prefix all the names of all allocated sections in the output file with
1590 @item --add-gnu-debuglink=@var{path-to-file}
1591 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1592 and adds it to the output file.
1594 @item --keep-file-symbols
1595 When stripping a file, perhaps with @option{--strip-debug} or
1596 @option{--strip-unneeded}, retain any symbols specifying source file names,
1597 which would otherwise get stripped.
1599 @item --only-keep-debug
1600 Strip a file, removing contents of any sections that would not be
1601 stripped by @option{--strip-debug} and leaving the debugging sections
1602 intact. In ELF files, this preserves all note sections in the output.
1604 The intention is that this option will be used in conjunction with
1605 @option{--add-gnu-debuglink} to create a two part executable. One a
1606 stripped binary which will occupy less space in RAM and in a
1607 distribution and the second a debugging information file which is only
1608 needed if debugging abilities are required. The suggested procedure
1609 to create these files is as follows:
1612 @item Link the executable as normal. Assuming that is is called
1614 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1615 create a file containing the debugging info.
1616 @item Run @code{objcopy --strip-debug foo} to create a
1617 stripped executable.
1618 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1619 to add a link to the debugging info into the stripped executable.
1622 Note---the choice of @code{.dbg} as an extension for the debug info
1623 file is arbitrary. Also the @code{--only-keep-debug} step is
1624 optional. You could instead do this:
1627 @item Link the executable as normal.
1628 @item Copy @code{foo} to @code{foo.full}
1629 @item Run @code{objcopy --strip-debug foo}
1630 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1633 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1634 full executable. It does not have to be a file created by the
1635 @option{--only-keep-debug} switch.
1637 Note---this switch is only intended for use on fully linked files. It
1638 does not make sense to use it on object files where the debugging
1639 information may be incomplete. Besides the gnu_debuglink feature
1640 currently only supports the presence of one filename containing
1641 debugging information, not multiple filenames on a one-per-object-file
1644 @item --file-alignment @var{num}
1645 Specify the file alignment. Sections in the file will always begin at
1646 file offsets which are multiples of this number. This defaults to
1648 [This option is specific to PE targets.]
1650 @item --heap @var{reserve}
1651 @itemx --heap @var{reserve},@var{commit}
1652 Specify the number of bytes of memory to reserve (and optionally commit)
1653 to be used as heap for this program.
1654 [This option is specific to PE targets.]
1656 @item --image-base @var{value}
1657 Use @var{value} as the base address of your program or dll. This is
1658 the lowest memory location that will be used when your program or dll
1659 is loaded. To reduce the need to relocate and improve performance of
1660 your dlls, each should have a unique base address and not overlap any
1661 other dlls. The default is 0x400000 for executables, and 0x10000000
1663 [This option is specific to PE targets.]
1665 @item --section-alignment @var{num}
1666 Sets the section alignment. Sections in memory will always begin at
1667 addresses which are a multiple of this number. Defaults to 0x1000.
1668 [This option is specific to PE targets.]
1670 @item --stack @var{reserve}
1671 @itemx --stack @var{reserve},@var{commit}
1672 Specify the number of bytes of memory to reserve (and optionally commit)
1673 to be used as stack for this program.
1674 [This option is specific to PE targets.]
1676 @item --subsystem @var{which}
1677 @itemx --subsystem @var{which}:@var{major}
1678 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1679 Specifies the subsystem under which your program will execute. The
1680 legal values for @var{which} are @code{native}, @code{windows},
1681 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1682 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1683 the subsystem version also. Numeric values are also accepted for
1685 [This option is specific to PE targets.]
1687 @item --extract-symbol
1688 Keep the file's section flags and symbols but remove all section data.
1689 Specifically, the option:
1692 @item removes the contents of all sections;
1693 @item sets the size of every section to zero; and
1694 @item sets the file's start address to zero.
1697 This option is used to build a @file{.sym} file for a VxWorks kernel.
1698 It can also be a useful way of reducing the size of a @option{--just-symbols}
1701 @item --compress-debug-sections
1702 Compress DWARF debug sections using zlib.
1704 @item --decompress-debug-sections
1705 Decompress DWARF debug sections using zlib.
1709 Show the version number of @command{objcopy}.
1713 Verbose output: list all object files modified. In the case of
1714 archives, @samp{objcopy -V} lists all members of the archive.
1717 Show a summary of the options to @command{objcopy}.
1720 Display a list showing all architectures and object formats available.
1726 @c man begin SEEALSO objcopy
1727 ld(1), objdump(1), and the Info entries for @file{binutils}.
1734 @cindex object file information
1737 @c man title objdump display information from object files.
1740 @c man begin SYNOPSIS objdump
1741 objdump [@option{-a}|@option{--archive-headers}]
1742 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1743 [@option{-C}|@option{--demangle}[=@var{style}] ]
1744 [@option{-d}|@option{--disassemble}]
1745 [@option{-D}|@option{--disassemble-all}]
1746 [@option{-z}|@option{--disassemble-zeroes}]
1747 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1748 [@option{-f}|@option{--file-headers}]
1749 [@option{-F}|@option{--file-offsets}]
1750 [@option{--file-start-context}]
1751 [@option{-g}|@option{--debugging}]
1752 [@option{-e}|@option{--debugging-tags}]
1753 [@option{-h}|@option{--section-headers}|@option{--headers}]
1754 [@option{-i}|@option{--info}]
1755 [@option{-j} @var{section}|@option{--section=}@var{section}]
1756 [@option{-l}|@option{--line-numbers}]
1757 [@option{-S}|@option{--source}]
1758 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1759 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1760 [@option{-p}|@option{--private-headers}]
1761 [@option{-P} @var{options}|@option{--private=}@var{options}]
1762 [@option{-r}|@option{--reloc}]
1763 [@option{-R}|@option{--dynamic-reloc}]
1764 [@option{-s}|@option{--full-contents}]
1765 [@option{-W[lLiaprmfFsoRt]}|
1766 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
1767 [@option{-G}|@option{--stabs}]
1768 [@option{-t}|@option{--syms}]
1769 [@option{-T}|@option{--dynamic-syms}]
1770 [@option{-x}|@option{--all-headers}]
1771 [@option{-w}|@option{--wide}]
1772 [@option{--start-address=}@var{address}]
1773 [@option{--stop-address=}@var{address}]
1774 [@option{--prefix-addresses}]
1775 [@option{--[no-]show-raw-insn}]
1776 [@option{--adjust-vma=}@var{offset}]
1777 [@option{--special-syms}]
1778 [@option{--prefix=}@var{prefix}]
1779 [@option{--prefix-strip=}@var{level}]
1780 [@option{--insn-width=}@var{width}]
1781 [@option{-V}|@option{--version}]
1782 [@option{-H}|@option{--help}]
1783 @var{objfile}@dots{}
1787 @c man begin DESCRIPTION objdump
1789 @command{objdump} displays information about one or more object files.
1790 The options control what particular information to display. This
1791 information is mostly useful to programmers who are working on the
1792 compilation tools, as opposed to programmers who just want their
1793 program to compile and work.
1795 @var{objfile}@dots{} are the object files to be examined. When you
1796 specify archives, @command{objdump} shows information on each of the member
1801 @c man begin OPTIONS objdump
1803 The long and short forms of options, shown here as alternatives, are
1804 equivalent. At least one option from the list
1805 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1809 @itemx --archive-header
1810 @cindex archive headers
1811 If any of the @var{objfile} files are archives, display the archive
1812 header information (in a format similar to @samp{ls -l}). Besides the
1813 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1814 the object file format of each archive member.
1816 @item --adjust-vma=@var{offset}
1817 @cindex section addresses in objdump
1818 @cindex VMA in objdump
1819 When dumping information, first add @var{offset} to all the section
1820 addresses. This is useful if the section addresses do not correspond to
1821 the symbol table, which can happen when putting sections at particular
1822 addresses when using a format which can not represent section addresses,
1825 @item -b @var{bfdname}
1826 @itemx --target=@var{bfdname}
1827 @cindex object code format
1828 Specify that the object-code format for the object files is
1829 @var{bfdname}. This option may not be necessary; @var{objdump} can
1830 automatically recognize many formats.
1834 objdump -b oasys -m vax -h fu.o
1837 displays summary information from the section headers (@option{-h}) of
1838 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1839 file in the format produced by Oasys compilers. You can list the
1840 formats available with the @option{-i} option.
1841 @xref{Target Selection}, for more information.
1844 @itemx --demangle[=@var{style}]
1845 @cindex demangling in objdump
1846 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1847 Besides removing any initial underscore prepended by the system, this
1848 makes C++ function names readable. Different compilers have different
1849 mangling styles. The optional demangling style argument can be used to
1850 choose an appropriate demangling style for your compiler. @xref{c++filt},
1851 for more information on demangling.
1855 Display debugging information. This attempts to parse STABS and IEEE
1856 debugging format information stored in the file and print it out using
1857 a C like syntax. If neither of these formats are found this option
1858 falls back on the @option{-W} option to print any DWARF information in
1862 @itemx --debugging-tags
1863 Like @option{-g}, but the information is generated in a format compatible
1867 @itemx --disassemble
1868 @cindex disassembling object code
1869 @cindex machine instructions
1870 Display the assembler mnemonics for the machine instructions from
1871 @var{objfile}. This option only disassembles those sections which are
1872 expected to contain instructions.
1875 @itemx --disassemble-all
1876 Like @option{-d}, but disassemble the contents of all sections, not just
1877 those expected to contain instructions.
1879 If the target is an ARM architecture this switch also has the effect
1880 of forcing the disassembler to decode pieces of data found in code
1881 sections as if they were instructions.
1883 @item --prefix-addresses
1884 When disassembling, print the complete address on each line. This is
1885 the older disassembly format.
1889 @itemx --endian=@{big|little@}
1891 @cindex disassembly endianness
1892 Specify the endianness of the object files. This only affects
1893 disassembly. This can be useful when disassembling a file format which
1894 does not describe endianness information, such as S-records.
1897 @itemx --file-headers
1898 @cindex object file header
1899 Display summary information from the overall header of
1900 each of the @var{objfile} files.
1903 @itemx --file-offsets
1904 @cindex object file offsets
1905 When disassembling sections, whenever a symbol is displayed, also
1906 display the file offset of the region of data that is about to be
1907 dumped. If zeroes are being skipped, then when disassembly resumes,
1908 tell the user how many zeroes were skipped and the file offset of the
1909 location from where the disassembly resumes. When dumping sections,
1910 display the file offset of the location from where the dump starts.
1912 @item --file-start-context
1913 @cindex source code context
1914 Specify that when displaying interlisted source code/disassembly
1915 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1916 context to the start of the file.
1919 @itemx --section-headers
1921 @cindex section headers
1922 Display summary information from the section headers of the
1925 File segments may be relocated to nonstandard addresses, for example by
1926 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1927 @command{ld}. However, some object file formats, such as a.out, do not
1928 store the starting address of the file segments. In those situations,
1929 although @command{ld} relocates the sections correctly, using @samp{objdump
1930 -h} to list the file section headers cannot show the correct addresses.
1931 Instead, it shows the usual addresses, which are implicit for the
1936 Print a summary of the options to @command{objdump} and exit.
1940 @cindex architectures available
1941 @cindex object formats available
1942 Display a list showing all architectures and object formats available
1943 for specification with @option{-b} or @option{-m}.
1946 @itemx --section=@var{name}
1947 @cindex section information
1948 Display information only for section @var{name}.
1951 @itemx --line-numbers
1952 @cindex source filenames for object files
1953 Label the display (using debugging information) with the filename and
1954 source line numbers corresponding to the object code or relocs shown.
1955 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1957 @item -m @var{machine}
1958 @itemx --architecture=@var{machine}
1959 @cindex architecture
1960 @cindex disassembly architecture
1961 Specify the architecture to use when disassembling object files. This
1962 can be useful when disassembling object files which do not describe
1963 architecture information, such as S-records. You can list the available
1964 architectures with the @option{-i} option.
1966 If the target is an ARM architecture then this switch has an
1967 additional effect. It restricts the disassembly to only those
1968 instructions supported by the architecture specified by @var{machine}.
1969 If it is necessary to use this switch because the input file does not
1970 contain any architecture information, but it is also desired to
1971 disassemble all the instructions use @option{-marm}.
1973 @item -M @var{options}
1974 @itemx --disassembler-options=@var{options}
1975 Pass target specific information to the disassembler. Only supported on
1976 some targets. If it is necessary to specify more than one
1977 disassembler option then multiple @option{-M} options can be used or
1978 can be placed together into a comma separated list.
1980 If the target is an ARM architecture then this switch can be used to
1981 select which register name set is used during disassembler. Specifying
1982 @option{-M reg-names-std} (the default) will select the register names as
1983 used in ARM's instruction set documentation, but with register 13 called
1984 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1985 @option{-M reg-names-apcs} will select the name set used by the ARM
1986 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1987 just use @samp{r} followed by the register number.
1989 There are also two variants on the APCS register naming scheme enabled
1990 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1991 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1992 with the normal register names or the special register names).
1994 This option can also be used for ARM architectures to force the
1995 disassembler to interpret all instructions as Thumb instructions by
1996 using the switch @option{--disassembler-options=force-thumb}. This can be
1997 useful when attempting to disassemble thumb code produced by other
2000 For the x86, some of the options duplicate functions of the @option{-m}
2001 switch, but allow finer grained control. Multiple selections from the
2002 following may be specified as a comma separated string.
2003 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
2004 the given architecture. @option{intel} and @option{att} select between
2005 intel syntax mode and AT&T syntax mode.
2006 @option{intel-mnemonic} and @option{att-mnemonic} select between
2007 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
2008 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
2009 @option{addr64}, @option{addr32},
2010 @option{addr16}, @option{data32} and @option{data16} specify the default
2011 address size and operand size. These four options will be overridden if
2012 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
2013 option string. Lastly, @option{suffix}, when in AT&T mode,
2014 instructs the disassembler to print a mnemonic suffix even when the
2015 suffix could be inferred by the operands.
2017 For PowerPC, @option{booke} controls the disassembly of BookE
2018 instructions. @option{32} and @option{64} select PowerPC and
2019 PowerPC64 disassembly, respectively. @option{e300} selects
2020 disassembly for the e300 family. @option{440} selects disassembly for
2021 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2022 single instructions of the PPC750CL.
2024 For MIPS, this option controls the printing of instruction mnemonic
2025 names and register names in disassembled instructions. Multiple
2026 selections from the following may be specified as a comma separated
2027 string, and invalid options are ignored:
2031 Print the 'raw' instruction mnemonic instead of some pseudo
2032 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2033 'sll' instead of 'nop', etc.
2035 @item gpr-names=@var{ABI}
2036 Print GPR (general-purpose register) names as appropriate
2037 for the specified ABI. By default, GPR names are selected according to
2038 the ABI of the binary being disassembled.
2040 @item fpr-names=@var{ABI}
2041 Print FPR (floating-point register) names as
2042 appropriate for the specified ABI. By default, FPR numbers are printed
2045 @item cp0-names=@var{ARCH}
2046 Print CP0 (system control coprocessor; coprocessor 0) register names
2047 as appropriate for the CPU or architecture specified by
2048 @var{ARCH}. By default, CP0 register names are selected according to
2049 the architecture and CPU of the binary being disassembled.
2051 @item hwr-names=@var{ARCH}
2052 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2053 as appropriate for the CPU or architecture specified by
2054 @var{ARCH}. By default, HWR names are selected according to
2055 the architecture and CPU of the binary being disassembled.
2057 @item reg-names=@var{ABI}
2058 Print GPR and FPR names as appropriate for the selected ABI.
2060 @item reg-names=@var{ARCH}
2061 Print CPU-specific register names (CP0 register and HWR names)
2062 as appropriate for the selected CPU or architecture.
2065 For any of the options listed above, @var{ABI} or
2066 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2067 rather than names, for the selected types of registers.
2068 You can list the available values of @var{ABI} and @var{ARCH} using
2069 the @option{--help} option.
2071 For VAX, you can specify function entry addresses with @option{-M
2072 entry:0xf00ba}. You can use this multiple times to properly
2073 disassemble VAX binary files that don't contain symbol tables (like
2074 ROM dumps). In these cases, the function entry mask would otherwise
2075 be decoded as VAX instructions, which would probably lead the rest
2076 of the function being wrongly disassembled.
2079 @itemx --private-headers
2080 Print information that is specific to the object file format. The exact
2081 information printed depends upon the object file format. For some
2082 object file formats, no additional information is printed.
2084 @item -P @var{options}
2085 @itemx --private=@var{options}
2086 Print information that is specific to the object file format. The
2087 argument @var{options} is a comma separated list that depends on the
2088 format (the lists of options is displayed with the help).
2090 For XCOFF, the available options are: @option{header}, @option{aout},
2091 @option{sections}, @option{syms}, @option{relocs}, @option{lineno},
2092 @option{loader}, @option{except}, @option{typchk}, @option{traceback}
2097 @cindex relocation entries, in object file
2098 Print the relocation entries of the file. If used with @option{-d} or
2099 @option{-D}, the relocations are printed interspersed with the
2103 @itemx --dynamic-reloc
2104 @cindex dynamic relocation entries, in object file
2105 Print the dynamic relocation entries of the file. This is only
2106 meaningful for dynamic objects, such as certain types of shared
2107 libraries. As for @option{-r}, if used with @option{-d} or
2108 @option{-D}, the relocations are printed interspersed with the
2112 @itemx --full-contents
2113 @cindex sections, full contents
2114 @cindex object file sections
2115 Display the full contents of any sections requested. By default all
2116 non-empty sections are displayed.
2120 @cindex source disassembly
2121 @cindex disassembly, with source
2122 Display source code intermixed with disassembly, if possible. Implies
2125 @item --prefix=@var{prefix}
2126 @cindex Add prefix to absolute paths
2127 Specify @var{prefix} to add to the absolute paths when used with
2130 @item --prefix-strip=@var{level}
2131 @cindex Strip absolute paths
2132 Indicate how many initial directory names to strip off the hardwired
2133 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2135 @item --show-raw-insn
2136 When disassembling instructions, print the instruction in hex as well as
2137 in symbolic form. This is the default except when
2138 @option{--prefix-addresses} is used.
2140 @item --no-show-raw-insn
2141 When disassembling instructions, do not print the instruction bytes.
2142 This is the default when @option{--prefix-addresses} is used.
2144 @item --insn-width=@var{width}
2145 @cindex Instruction width
2146 Display @var{width} bytes on a single line when disassembling
2149 @item -W[lLiaprmfFsoRt]
2150 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
2152 @cindex debug symbols
2153 Displays the contents of the debug sections in the file, if any are
2154 present. If one of the optional letters or words follows the switch
2155 then only data found in those specific sections will be dumped.
2157 Note that there is no single letter option to display the content of
2158 trace sections or .gdb_index.
2160 Note: the output from the @option{=info} option can also be affected
2161 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
2163 @item --dwarf-depth=@var{n}
2164 Limit the dump of the @code{.debug_info} section to @var{n} children.
2165 This is only useful with @option{--dwarf=info}. The default is
2166 to print all DIEs; the special value 0 for @var{n} will also have this
2169 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2170 levels will not be printed. The range for @var{n} is zero-based.
2172 @item --dwarf-start=@var{n}
2173 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2174 useful with @option{--dwarf=info}.
2176 If specified, this option will suppress printing of any header
2177 information and all DIEs before the DIE numbered @var{n}. Only
2178 siblings and children of the specified DIE will be printed.
2180 This can be used in conjunction with @option{--dwarf-depth}.
2186 @cindex debug symbols
2187 @cindex ELF object file format
2188 Display the full contents of any sections requested. Display the
2189 contents of the .stab and .stab.index and .stab.excl sections from an
2190 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2191 @code{.stab} debugging symbol-table entries are carried in an ELF
2192 section. In most other file formats, debugging symbol-table entries are
2193 interleaved with linkage symbols, and are visible in the @option{--syms}
2196 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
2197 Overview,stabs.info, The ``stabs'' debug format}.
2200 @item --start-address=@var{address}
2201 @cindex start-address
2202 Start displaying data at the specified address. This affects the output
2203 of the @option{-d}, @option{-r} and @option{-s} options.
2205 @item --stop-address=@var{address}
2206 @cindex stop-address
2207 Stop displaying data at the specified address. This affects the output
2208 of the @option{-d}, @option{-r} and @option{-s} options.
2212 @cindex symbol table entries, printing
2213 Print the symbol table entries of the file.
2214 This is similar to the information provided by the @samp{nm} program,
2215 although the display format is different. The format of the output
2216 depends upon the format of the file being dumped, but there are two main
2217 types. One looks like this:
2220 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2221 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2224 where the number inside the square brackets is the number of the entry
2225 in the symbol table, the @var{sec} number is the section number, the
2226 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2227 symbol's type, the @var{scl} number is the symbol's storage class and
2228 the @var{nx} value is the number of auxilary entries associated with
2229 the symbol. The last two fields are the symbol's value and its name.
2231 The other common output format, usually seen with ELF based files,
2235 00000000 l d .bss 00000000 .bss
2236 00000000 g .text 00000000 fred
2239 Here the first number is the symbol's value (sometimes refered to as
2240 its address). The next field is actually a set of characters and
2241 spaces indicating the flag bits that are set on the symbol. These
2242 characters are described below. Next is the section with which the
2243 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2244 not connected with any section), or @emph{*UND*} if the section is
2245 referenced in the file being dumped, but not defined there.
2247 After the section name comes another field, a number, which for common
2248 symbols is the alignment and for other symbol is the size. Finally
2249 the symbol's name is displayed.
2251 The flag characters are divided into 7 groups as follows:
2257 The symbol is a local (l), global (g), unique global (u), neither
2258 global nor local (a space) or both global and local (!). A
2259 symbol can be neither local or global for a variety of reasons, e.g.,
2260 because it is used for debugging, but it is probably an indication of
2261 a bug if it is ever both local and global. Unique global symbols are
2262 a GNU extension to the standard set of ELF symbol bindings. For such
2263 a symbol the dynamic linker will make sure that in the entire process
2264 there is just one symbol with this name and type in use.
2267 The symbol is weak (w) or strong (a space).
2270 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2273 The symbol is a warning (W) or a normal symbol (a space). A warning
2274 symbol's name is a message to be displayed if the symbol following the
2275 warning symbol is ever referenced.
2279 The symbol is an indirect reference to another symbol (I), a function
2280 to be evaluated during reloc processing (i) or a normal symbol (a
2285 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2286 normal symbol (a space).
2291 The symbol is the name of a function (F) or a file (f) or an object
2292 (O) or just a normal symbol (a space).
2296 @itemx --dynamic-syms
2297 @cindex dynamic symbol table entries, printing
2298 Print the dynamic symbol table entries of the file. This is only
2299 meaningful for dynamic objects, such as certain types of shared
2300 libraries. This is similar to the information provided by the @samp{nm}
2301 program when given the @option{-D} (@option{--dynamic}) option.
2303 @item --special-syms
2304 When displaying symbols include those which the target considers to be
2305 special in some way and which would not normally be of interest to the
2310 Print the version number of @command{objdump} and exit.
2313 @itemx --all-headers
2314 @cindex all header information, object file
2315 @cindex header information, all
2316 Display all available header information, including the symbol table and
2317 relocation entries. Using @option{-x} is equivalent to specifying all of
2318 @option{-a -f -h -p -r -t}.
2322 @cindex wide output, printing
2323 Format some lines for output devices that have more than 80 columns.
2324 Also do not truncate symbol names when they are displayed.
2327 @itemx --disassemble-zeroes
2328 Normally the disassembly output will skip blocks of zeroes. This
2329 option directs the disassembler to disassemble those blocks, just like
2336 @c man begin SEEALSO objdump
2337 nm(1), readelf(1), and the Info entries for @file{binutils}.
2345 @cindex archive contents
2346 @cindex symbol index
2348 @c man title ranlib generate index to archive.
2351 @c man begin SYNOPSIS ranlib
2352 ranlib [@option{-vVt}] @var{archive}
2356 @c man begin DESCRIPTION ranlib
2358 @command{ranlib} generates an index to the contents of an archive and
2359 stores it in the archive. The index lists each symbol defined by a
2360 member of an archive that is a relocatable object file.
2362 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2364 An archive with such an index speeds up linking to the library and
2365 allows routines in the library to call each other without regard to
2366 their placement in the archive.
2368 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2369 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2374 @c man begin OPTIONS ranlib
2380 Show the version number of @command{ranlib}.
2383 Update the timestamp of the symbol map of an archive.
2389 @c man begin SEEALSO ranlib
2390 ar(1), nm(1), and the Info entries for @file{binutils}.
2398 @cindex section sizes
2400 @c man title size list section sizes and total size.
2403 @c man begin SYNOPSIS size
2404 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2406 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2408 [@option{-t}|@option{--totals}]
2409 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2410 [@var{objfile}@dots{}]
2414 @c man begin DESCRIPTION size
2416 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2417 size---for each of the object or archive files @var{objfile} in its
2418 argument list. By default, one line of output is generated for each
2419 object file or each module in an archive.
2421 @var{objfile}@dots{} are the object files to be examined.
2422 If none are specified, the file @code{a.out} will be used.
2426 @c man begin OPTIONS size
2428 The command line options have the following meanings:
2433 @itemx --format=@var{compatibility}
2434 @cindex @command{size} display format
2435 Using one of these options, you can choose whether the output from @sc{gnu}
2436 @command{size} resembles output from System V @command{size} (using @option{-A},
2437 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2438 @option{--format=berkeley}). The default is the one-line format similar to
2440 @c Bonus for doc-source readers: you can also say --format=strange (or
2441 @c anything else that starts with 's') for sysv, and --format=boring (or
2442 @c anything else that starts with 'b') for Berkeley.
2444 Here is an example of the Berkeley (default) format of output from
2447 $ size --format=Berkeley ranlib size
2448 text data bss dec hex filename
2449 294880 81920 11592 388392 5ed28 ranlib
2450 294880 81920 11888 388688 5ee50 size
2454 This is the same data, but displayed closer to System V conventions:
2457 $ size --format=SysV ranlib size
2475 Show a summary of acceptable arguments and options.
2480 @itemx --radix=@var{number}
2481 @cindex @command{size} number format
2482 @cindex radix for section sizes
2483 Using one of these options, you can control whether the size of each
2484 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2485 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2486 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2487 values (8, 10, 16) are supported. The total size is always given in two
2488 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2489 octal and hexadecimal if you're using @option{-o}.
2492 Print total size of common symbols in each file. When using Berkeley
2493 format these are included in the bss size.
2497 Show totals of all objects listed (Berkeley format listing mode only).
2499 @item --target=@var{bfdname}
2500 @cindex object code format
2501 Specify that the object-code format for @var{objfile} is
2502 @var{bfdname}. This option may not be necessary; @command{size} can
2503 automatically recognize many formats.
2504 @xref{Target Selection}, for more information.
2508 Display the version number of @command{size}.
2514 @c man begin SEEALSO size
2515 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2522 @cindex listings strings
2523 @cindex printing strings
2524 @cindex strings, printing
2526 @c man title strings print the strings of printable characters in files.
2529 @c man begin SYNOPSIS strings
2530 strings [@option{-afovV}] [@option{-}@var{min-len}]
2531 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2532 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2533 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2534 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2535 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2536 [@option{--help}] [@option{--version}] @var{file}@dots{}
2540 @c man begin DESCRIPTION strings
2542 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2543 character sequences that are at least 4 characters long (or the number
2544 given with the options below) and are followed by an unprintable
2545 character. By default, it only prints the strings from the initialized
2546 and loaded sections of object files; for other types of files, it prints
2547 the strings from the whole file.
2549 @command{strings} is mainly useful for determining the contents of non-text
2554 @c man begin OPTIONS strings
2560 Do not scan only the initialized and loaded sections of object files;
2561 scan the whole files.
2564 @itemx --print-file-name
2565 Print the name of the file before each string.
2568 Print a summary of the program usage on the standard output and exit.
2570 @item -@var{min-len}
2571 @itemx -n @var{min-len}
2572 @itemx --bytes=@var{min-len}
2573 Print sequences of characters that are at least @var{min-len} characters
2574 long, instead of the default 4.
2577 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2578 act like @samp{-t d} instead. Since we can not be compatible with both
2579 ways, we simply chose one.
2581 @item -t @var{radix}
2582 @itemx --radix=@var{radix}
2583 Print the offset within the file before each string. The single
2584 character argument specifies the radix of the offset---@samp{o} for
2585 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2587 @item -e @var{encoding}
2588 @itemx --encoding=@var{encoding}
2589 Select the character encoding of the strings that are to be found.
2590 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2591 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2592 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2593 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2594 littleendian. Useful for finding wide character strings. (@samp{l}
2595 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2597 @item -T @var{bfdname}
2598 @itemx --target=@var{bfdname}
2599 @cindex object code format
2600 Specify an object code format other than your system's default format.
2601 @xref{Target Selection}, for more information.
2606 Print the program version number on the standard output and exit.
2612 @c man begin SEEALSO strings
2613 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2614 and the Info entries for @file{binutils}.
2622 @cindex removing symbols
2623 @cindex discarding symbols
2624 @cindex symbols, discarding
2626 @c man title strip Discard symbols from object files.
2629 @c man begin SYNOPSIS strip
2630 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2631 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2632 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2633 [@option{-s}|@option{--strip-all}]
2634 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2635 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2636 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2637 [@option{-w}|@option{--wildcard}]
2638 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2639 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2640 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2641 [@option{--keep-file-symbols}]
2642 [@option{--only-keep-debug}]
2643 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2644 [@option{--help}] [@option{--info}]
2645 @var{objfile}@dots{}
2649 @c man begin DESCRIPTION strip
2651 @sc{gnu} @command{strip} discards all symbols from object files
2652 @var{objfile}. The list of object files may include archives.
2653 At least one object file must be given.
2655 @command{strip} modifies the files named in its argument,
2656 rather than writing modified copies under different names.
2660 @c man begin OPTIONS strip
2663 @item -F @var{bfdname}
2664 @itemx --target=@var{bfdname}
2665 Treat the original @var{objfile} as a file with the object
2666 code format @var{bfdname}, and rewrite it in the same format.
2667 @xref{Target Selection}, for more information.
2670 Show a summary of the options to @command{strip} and exit.
2673 Display a list showing all architectures and object formats available.
2675 @item -I @var{bfdname}
2676 @itemx --input-target=@var{bfdname}
2677 Treat the original @var{objfile} as a file with the object
2678 code format @var{bfdname}.
2679 @xref{Target Selection}, for more information.
2681 @item -O @var{bfdname}
2682 @itemx --output-target=@var{bfdname}
2683 Replace @var{objfile} with a file in the output format @var{bfdname}.
2684 @xref{Target Selection}, for more information.
2686 @item -R @var{sectionname}
2687 @itemx --remove-section=@var{sectionname}
2688 Remove any section named @var{sectionname} from the output file. This
2689 option may be given more than once. Note that using this option
2690 inappropriately may make the output file unusable.
2699 @itemx --strip-debug
2700 Remove debugging symbols only.
2702 @item --strip-unneeded
2703 Remove all symbols that are not needed for relocation processing.
2705 @item -K @var{symbolname}
2706 @itemx --keep-symbol=@var{symbolname}
2707 When stripping symbols, keep symbol @var{symbolname} even if it would
2708 normally be stripped. This option may be given more than once.
2710 @item -N @var{symbolname}
2711 @itemx --strip-symbol=@var{symbolname}
2712 Remove symbol @var{symbolname} from the source file. This option may be
2713 given more than once, and may be combined with strip options other than
2717 Put the stripped output in @var{file}, rather than replacing the
2718 existing file. When this argument is used, only one @var{objfile}
2719 argument may be specified.
2722 @itemx --preserve-dates
2723 Preserve the access and modification dates of the file.
2727 Permit regular expressions in @var{symbolname}s used in other command
2728 line options. The question mark (?), asterisk (*), backslash (\) and
2729 square brackets ([]) operators can be used anywhere in the symbol
2730 name. If the first character of the symbol name is the exclamation
2731 point (!) then the sense of the switch is reversed for that symbol.
2738 would cause strip to only keep symbols that start with the letters
2739 ``fo'', but to discard the symbol ``foo''.
2742 @itemx --discard-all
2743 Remove non-global symbols.
2746 @itemx --discard-locals
2747 Remove compiler-generated local symbols.
2748 (These usually start with @samp{L} or @samp{.}.)
2750 @item --keep-file-symbols
2751 When stripping a file, perhaps with @option{--strip-debug} or
2752 @option{--strip-unneeded}, retain any symbols specifying source file names,
2753 which would otherwise get stripped.
2755 @item --only-keep-debug
2756 Strip a file, removing contents of any sections that would not be
2757 stripped by @option{--strip-debug} and leaving the debugging sections
2758 intact. In ELF files, this preserves all note sections in the output.
2760 The intention is that this option will be used in conjunction with
2761 @option{--add-gnu-debuglink} to create a two part executable. One a
2762 stripped binary which will occupy less space in RAM and in a
2763 distribution and the second a debugging information file which is only
2764 needed if debugging abilities are required. The suggested procedure
2765 to create these files is as follows:
2768 @item Link the executable as normal. Assuming that is is called
2770 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2771 create a file containing the debugging info.
2772 @item Run @code{objcopy --strip-debug foo} to create a
2773 stripped executable.
2774 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2775 to add a link to the debugging info into the stripped executable.
2778 Note---the choice of @code{.dbg} as an extension for the debug info
2779 file is arbitrary. Also the @code{--only-keep-debug} step is
2780 optional. You could instead do this:
2783 @item Link the executable as normal.
2784 @item Copy @code{foo} to @code{foo.full}
2785 @item Run @code{strip --strip-debug foo}
2786 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2789 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2790 full executable. It does not have to be a file created by the
2791 @option{--only-keep-debug} switch.
2793 Note---this switch is only intended for use on fully linked files. It
2794 does not make sense to use it on object files where the debugging
2795 information may be incomplete. Besides the gnu_debuglink feature
2796 currently only supports the presence of one filename containing
2797 debugging information, not multiple filenames on a one-per-object-file
2802 Show the version number for @command{strip}.
2806 Verbose output: list all object files modified. In the case of
2807 archives, @samp{strip -v} lists all members of the archive.
2813 @c man begin SEEALSO strip
2814 the Info entries for @file{binutils}.
2818 @node c++filt, addr2line, elfedit, Top
2822 @cindex demangling C++ symbols
2824 @c man title cxxfilt Demangle C++ and Java symbols.
2827 @c man begin SYNOPSIS cxxfilt
2828 c++filt [@option{-_}|@option{--strip-underscores}]
2829 [@option{-n}|@option{--no-strip-underscores}]
2830 [@option{-p}|@option{--no-params}]
2831 [@option{-t}|@option{--types}]
2832 [@option{-i}|@option{--no-verbose}]
2833 [@option{-s} @var{format}|@option{--format=}@var{format}]
2834 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2838 @c man begin DESCRIPTION cxxfilt
2841 The C++ and Java languages provide function overloading, which means
2842 that you can write many functions with the same name, providing that
2843 each function takes parameters of different types. In order to be
2844 able to distinguish these similarly named functions C++ and Java
2845 encode them into a low-level assembler name which uniquely identifies
2846 each different version. This process is known as @dfn{mangling}. The
2848 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2849 MS-DOS this program is named @command{CXXFILT}.}
2850 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2851 names into user-level names so that they can be read.
2853 Every alphanumeric word (consisting of letters, digits, underscores,
2854 dollars, or periods) seen in the input is a potential mangled name.
2855 If the name decodes into a C++ name, the C++ name replaces the
2856 low-level name in the output, otherwise the original word is output.
2857 In this way you can pass an entire assembler source file, containing
2858 mangled names, through @command{c++filt} and see the same source file
2859 containing demangled names.
2861 You can also use @command{c++filt} to decipher individual symbols by
2862 passing them on the command line:
2865 c++filt @var{symbol}
2868 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2869 names from the standard input instead. All the results are printed on
2870 the standard output. The difference between reading names from the
2871 command line versus reading names from the standard input is that
2872 command line arguments are expected to be just mangled names and no
2873 checking is performed to separate them from surrounding text. Thus
2880 will work and demangle the name to ``f()'' whereas:
2886 will not work. (Note the extra comma at the end of the mangled
2887 name which makes it invalid). This command however will work:
2890 echo _Z1fv, | c++filt -n
2893 and will display ``f(),'', i.e., the demangled name followed by a
2894 trailing comma. This behaviour is because when the names are read
2895 from the standard input it is expected that they might be part of an
2896 assembler source file where there might be extra, extraneous
2897 characters trailing after a mangled name. For example:
2900 .type _Z1fv, @@function
2905 @c man begin OPTIONS cxxfilt
2909 @itemx --strip-underscores
2910 On some systems, both the C and C++ compilers put an underscore in front
2911 of every name. For example, the C name @code{foo} gets the low-level
2912 name @code{_foo}. This option removes the initial underscore. Whether
2913 @command{c++filt} removes the underscore by default is target dependent.
2916 @itemx --no-strip-underscores
2917 Do not remove the initial underscore.
2921 When demangling the name of a function, do not display the types of
2922 the function's parameters.
2926 Attempt to demangle types as well as function names. This is disabled
2927 by default since mangled types are normally only used internally in
2928 the compiler, and they can be confused with non-mangled names. For example,
2929 a function called ``a'' treated as a mangled type name would be
2930 demangled to ``signed char''.
2934 Do not include implementation details (if any) in the demangled
2937 @item -s @var{format}
2938 @itemx --format=@var{format}
2939 @command{c++filt} can decode various methods of mangling, used by
2940 different compilers. The argument to this option selects which
2945 Automatic selection based on executable (the default method)
2947 the one used by the @sc{gnu} C++ compiler (g++)
2949 the one used by the Lucid compiler (lcc)
2951 the one specified by the C++ Annotated Reference Manual
2953 the one used by the HP compiler (aCC)
2955 the one used by the EDG compiler
2957 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2959 the one used by the @sc{gnu} Java compiler (gcj)
2961 the one used by the @sc{gnu} Ada compiler (GNAT).
2965 Print a summary of the options to @command{c++filt} and exit.
2968 Print the version number of @command{c++filt} and exit.
2974 @c man begin SEEALSO cxxfilt
2975 the Info entries for @file{binutils}.
2980 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2981 user interface are subject to change in future releases. In particular,
2982 a command-line option may be required in the future to decode a name
2983 passed as an argument on the command line; in other words,
2986 c++filt @var{symbol}
2990 may in a future release become
2993 c++filt @var{option} @var{symbol}
3001 @cindex address to file name and line number
3003 @c man title addr2line convert addresses into file names and line numbers.
3006 @c man begin SYNOPSIS addr2line
3007 addr2line [@option{-a}|@option{--addresses}]
3008 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3009 [@option{-C}|@option{--demangle}[=@var{style}]]
3010 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3011 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3012 [@option{-i}|@option{--inlines}]
3013 [@option{-p}|@option{--pretty-print}]
3014 [@option{-j}|@option{--section=}@var{name}]
3015 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3020 @c man begin DESCRIPTION addr2line
3022 @command{addr2line} translates addresses into file names and line numbers.
3023 Given an address in an executable or an offset in a section of a relocatable
3024 object, it uses the debugging information to figure out which file name and
3025 line number are associated with it.
3027 The executable or relocatable object to use is specified with the @option{-e}
3028 option. The default is the file @file{a.out}. The section in the relocatable
3029 object to use is specified with the @option{-j} option.
3031 @command{addr2line} has two modes of operation.
3033 In the first, hexadecimal addresses are specified on the command line,
3034 and @command{addr2line} displays the file name and line number for each
3037 In the second, @command{addr2line} reads hexadecimal addresses from
3038 standard input, and prints the file name and line number for each
3039 address on standard output. In this mode, @command{addr2line} may be used
3040 in a pipe to convert dynamically chosen addresses.
3042 The format of the output is @samp{FILENAME:LINENO}. The file name and
3043 line number for each address is printed on a separate line. If the
3044 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
3045 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
3046 containing the address. If the @command{-a} option is used, then the
3047 address read is first printed.
3049 If the file name or function name can not be determined,
3050 @command{addr2line} will print two question marks in their place. If the
3051 line number can not be determined, @command{addr2line} will print 0.
3055 @c man begin OPTIONS addr2line
3057 The long and short forms of options, shown here as alternatives, are
3063 Display address before function names or file and line number
3064 information. The address is printed with a @samp{0x} prefix to easily
3067 @item -b @var{bfdname}
3068 @itemx --target=@var{bfdname}
3069 @cindex object code format
3070 Specify that the object-code format for the object files is
3074 @itemx --demangle[=@var{style}]
3075 @cindex demangling in objdump
3076 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3077 Besides removing any initial underscore prepended by the system, this
3078 makes C++ function names readable. Different compilers have different
3079 mangling styles. The optional demangling style argument can be used to
3080 choose an appropriate demangling style for your compiler. @xref{c++filt},
3081 for more information on demangling.
3083 @item -e @var{filename}
3084 @itemx --exe=@var{filename}
3085 Specify the name of the executable for which addresses should be
3086 translated. The default file is @file{a.out}.
3090 Display function names as well as file and line number information.
3094 Display only the base of each file name.
3098 If the address belongs to a function that was inlined, the source
3099 information for all enclosing scopes back to the first non-inlined
3100 function will also be printed. For example, if @code{main} inlines
3101 @code{callee1} which inlines @code{callee2}, and address is from
3102 @code{callee2}, the source information for @code{callee1} and @code{main}
3103 will also be printed.
3107 Read offsets relative to the specified section instead of absolute addresses.
3110 @itemx --pretty-print
3111 Make the output more human friendly: each location are printed on one line.
3112 If option @option{-i} is specified, lines for all enclosing scopes are
3113 prefixed with @samp{(inlined by)}.
3119 @c man begin SEEALSO addr2line
3120 Info entries for @file{binutils}.
3127 @command{nlmconv} converts a relocatable object file into a NetWare
3131 @command{nlmconv} currently works with @samp{i386} object
3132 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3133 object files in @sc{elf}, or @code{a.out} format@footnote{
3134 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3135 format in the Binary File Descriptor library. It has only been tested
3136 with the above formats.}.
3140 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3141 utilities, since it is only useful for NLM targets.
3144 @c man title nlmconv converts object code into an NLM.
3147 @c man begin SYNOPSIS nlmconv
3148 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3149 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3150 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3151 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3152 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3153 @var{infile} @var{outfile}
3157 @c man begin DESCRIPTION nlmconv
3159 @command{nlmconv} converts the relocatable @samp{i386} object file
3160 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3161 reading @var{headerfile} for NLM header information. For instructions
3162 on writing the NLM command file language used in header files, see the
3163 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3164 Development and Tools Overview}, which is part of the NLM Software
3165 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3166 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3169 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3172 @command{nlmconv} can perform a link step. In other words, you can list
3173 more than one object file for input if you list them in the definitions
3174 file (rather than simply specifying one input file on the command line).
3175 In this case, @command{nlmconv} calls the linker for you.
3179 @c man begin OPTIONS nlmconv
3182 @item -I @var{bfdname}
3183 @itemx --input-target=@var{bfdname}
3184 Object format of the input file. @command{nlmconv} can usually determine
3185 the format of a given file (so no default is necessary).
3186 @xref{Target Selection}, for more information.
3188 @item -O @var{bfdname}
3189 @itemx --output-target=@var{bfdname}
3190 Object format of the output file. @command{nlmconv} infers the output
3191 format based on the input format, e.g. for a @samp{i386} input file the
3192 output format is @samp{nlm32-i386}.
3193 @xref{Target Selection}, for more information.
3195 @item -T @var{headerfile}
3196 @itemx --header-file=@var{headerfile}
3197 Reads @var{headerfile} for NLM header information. For instructions on
3198 writing the NLM command file language used in header files, see@ see the
3199 @samp{linkers} section, of the @cite{NLM Development and Tools
3200 Overview}, which is part of the NLM Software Developer's Kit, available
3205 Displays (on standard error) the linker command line used by @command{nlmconv}.
3207 @item -l @var{linker}
3208 @itemx --linker=@var{linker}
3209 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3214 Prints a usage summary.
3218 Prints the version number for @command{nlmconv}.
3224 @c man begin SEEALSO nlmconv
3225 the Info entries for @file{binutils}.
3232 @command{windmc} may be used to generator Windows message resources.
3235 @emph{Warning:} @command{windmc} is not always built as part of the binary
3236 utilities, since it is only useful for Windows targets.
3239 @c man title windmc generates Windows message resources.
3242 @c man begin SYNOPSIS windmc
3243 windmc [options] input-file
3247 @c man begin DESCRIPTION windmc
3249 @command{windmc} reads message definitions from an input file (.mc) and
3250 translate them into a set of output files. The output files may be of
3255 A C header file containing the message definitions.
3258 A resource file compilable by the @command{windres} tool.
3261 One or more binary files containing the resource data for a specific
3265 A C include file that maps message id's to their symbolic name.
3268 The exact description of these different formats is available in
3269 documentation from Microsoft.
3271 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3272 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3273 Windows Message Compiler.
3277 @c man begin OPTIONS windmc
3282 Specifies that the input file specified is ASCII. This is the default
3287 Specifies that messages in the output @code{bin} files should be in ASCII
3292 Specifies that @code{bin} filenames should have to be prefixed by the
3293 basename of the source file.
3297 Sets the customer bit in all message id's.
3299 @item -C @var{codepage}
3300 @itemx --codepage_in @var{codepage}
3301 Sets the default codepage to be used to convert input file to UTF16. The
3302 default is ocdepage 1252.
3305 @itemx --decimal_values
3306 Outputs the constants in the header file in decimal. Default is using
3310 @itemx --extension @var{ext}
3311 The extension for the header file. The default is .h extension.
3313 @item -F @var{target}
3314 @itemx --target @var{target}
3315 Specify the BFD format to use for a bin file as output. This
3316 is a BFD target name; you can use the @option{--help} option to see a list
3317 of supported targets. Normally @command{windmc} will use the default
3318 format, which is the first one listed by the @option{--help} option.
3320 @ref{Target Selection}.
3324 @itemx --headerdir @var{path}
3325 The target directory of the generated header file. The default is the
3330 Displays a list of command line options and then exits.
3332 @item -m @var{characters}
3333 @itemx --maxlength @var{characters}
3334 Instructs @command{windmc} to generate a warning if the length
3335 of any message exceeds the number specified.
3338 @itemx --nullterminate
3339 Terminate message text in @code{bin} files by zero. By default they are
3340 terminated by CR/LF.
3343 @itemx --hresult_use
3344 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3345 file, using HRESULT definitions. Status codes are used if the flag is not
3348 @item -O @var{codepage}
3349 @itemx --codepage_out @var{codepage}
3350 Sets the default codepage to be used to output text files. The default
3354 @itemx --rcdir @var{path}
3355 The target directory for the generated @code{rc} script and the generated
3356 @code{bin} files that the resource compiler script includes. The default
3357 is the current directory.
3361 Specifies that the input file is UTF16.
3364 @itemx --unicode_out
3365 Specifies that messages in the output @code{bin} file should be in UTF16
3366 format. This is the default behaviour.
3370 Enable verbose mode.
3374 Prints the version number for @command{windmc}.
3377 @itemx --xdgb @var{path}
3378 The path of the @code{dbg} C include file that maps message id's to the
3379 symbolic name. No such file is generated without specifying the switch.
3385 @c man begin SEEALSO windmc
3386 the Info entries for @file{binutils}.
3393 @command{windres} may be used to manipulate Windows resources.
3396 @emph{Warning:} @command{windres} is not always built as part of the binary
3397 utilities, since it is only useful for Windows targets.
3400 @c man title windres manipulate Windows resources.
3403 @c man begin SYNOPSIS windres
3404 windres [options] [input-file] [output-file]
3408 @c man begin DESCRIPTION windres
3410 @command{windres} reads resources from an input file and copies them into
3411 an output file. Either file may be in one of three formats:
3415 A text format read by the Resource Compiler.
3418 A binary format generated by the Resource Compiler.
3421 A COFF object or executable.
3424 The exact description of these different formats is available in
3425 documentation from Microsoft.
3427 When @command{windres} converts from the @code{rc} format to the @code{res}
3428 format, it is acting like the Windows Resource Compiler. When
3429 @command{windres} converts from the @code{res} format to the @code{coff}
3430 format, it is acting like the Windows @code{CVTRES} program.
3432 When @command{windres} generates an @code{rc} file, the output is similar
3433 but not identical to the format expected for the input. When an input
3434 @code{rc} file refers to an external filename, an output @code{rc} file
3435 will instead include the file contents.
3437 If the input or output format is not specified, @command{windres} will
3438 guess based on the file name, or, for the input file, the file contents.
3439 A file with an extension of @file{.rc} will be treated as an @code{rc}
3440 file, a file with an extension of @file{.res} will be treated as a
3441 @code{res} file, and a file with an extension of @file{.o} or
3442 @file{.exe} will be treated as a @code{coff} file.
3444 If no output file is specified, @command{windres} will print the resources
3445 in @code{rc} format to standard output.
3447 The normal use is for you to write an @code{rc} file, use @command{windres}
3448 to convert it to a COFF object file, and then link the COFF file into
3449 your application. This will make the resources described in the
3450 @code{rc} file available to Windows.
3454 @c man begin OPTIONS windres
3457 @item -i @var{filename}
3458 @itemx --input @var{filename}
3459 The name of the input file. If this option is not used, then
3460 @command{windres} will use the first non-option argument as the input file
3461 name. If there are no non-option arguments, then @command{windres} will
3462 read from standard input. @command{windres} can not read a COFF file from
3465 @item -o @var{filename}
3466 @itemx --output @var{filename}
3467 The name of the output file. If this option is not used, then
3468 @command{windres} will use the first non-option argument, after any used
3469 for the input file name, as the output file name. If there is no
3470 non-option argument, then @command{windres} will write to standard output.
3471 @command{windres} can not write a COFF file to standard output. Note,
3472 for compatibility with @command{rc} the option @option{-fo} is also
3473 accepted, but its use is not recommended.
3475 @item -J @var{format}
3476 @itemx --input-format @var{format}
3477 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3478 @samp{coff}. If no input format is specified, @command{windres} will
3479 guess, as described above.
3481 @item -O @var{format}
3482 @itemx --output-format @var{format}
3483 The output format to generate. @var{format} may be @samp{res},
3484 @samp{rc}, or @samp{coff}. If no output format is specified,
3485 @command{windres} will guess, as described above.
3487 @item -F @var{target}
3488 @itemx --target @var{target}
3489 Specify the BFD format to use for a COFF file as input or output. This
3490 is a BFD target name; you can use the @option{--help} option to see a list
3491 of supported targets. Normally @command{windres} will use the default
3492 format, which is the first one listed by the @option{--help} option.
3494 @ref{Target Selection}.
3497 @item --preprocessor @var{program}
3498 When @command{windres} reads an @code{rc} file, it runs it through the C
3499 preprocessor first. This option may be used to specify the preprocessor
3500 to use, including any leading arguments. The default preprocessor
3501 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3503 @item --preprocessor-arg @var{option}
3504 When @command{windres} reads an @code{rc} file, it runs it through
3505 the C preprocessor first. This option may be used to specify additional
3506 text to be passed to preprocessor on its command line.
3507 This option can be used multiple times to add multiple options to the
3508 preprocessor command line.
3510 @item -I @var{directory}
3511 @itemx --include-dir @var{directory}
3512 Specify an include directory to use when reading an @code{rc} file.
3513 @command{windres} will pass this to the preprocessor as an @option{-I}
3514 option. @command{windres} will also search this directory when looking for
3515 files named in the @code{rc} file. If the argument passed to this command
3516 matches any of the supported @var{formats} (as described in the @option{-J}
3517 option), it will issue a deprecation warning, and behave just like the
3518 @option{-J} option. New programs should not use this behaviour. If a
3519 directory happens to match a @var{format}, simple prefix it with @samp{./}
3520 to disable the backward compatibility.
3522 @item -D @var{target}
3523 @itemx --define @var{sym}[=@var{val}]
3524 Specify a @option{-D} option to pass to the preprocessor when reading an
3527 @item -U @var{target}
3528 @itemx --undefine @var{sym}
3529 Specify a @option{-U} option to pass to the preprocessor when reading an
3533 Ignored for compatibility with rc.
3536 Enable verbose mode. This tells you what the preprocessor is if you
3540 @item --codepage @var{val}
3541 Specify the default codepage to use when reading an @code{rc} file.
3542 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3543 codepage code. The valid range is from zero up to 0xffff, but the
3544 validity of the codepage is host and configuration dependent.
3547 @item --language @var{val}
3548 Specify the default language to use when reading an @code{rc} file.
3549 @var{val} should be a hexadecimal language code. The low eight bits are
3550 the language, and the high eight bits are the sublanguage.
3552 @item --use-temp-file
3553 Use a temporary file to instead of using popen to read the output of
3554 the preprocessor. Use this option if the popen implementation is buggy
3555 on the host (eg., certain non-English language versions of Windows 95 and
3556 Windows 98 are known to have buggy popen where the output will instead
3559 @item --no-use-temp-file
3560 Use popen, not a temporary file, to read the output of the preprocessor.
3561 This is the default behaviour.
3565 Prints a usage summary.
3569 Prints the version number for @command{windres}.
3572 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3573 this will turn on parser debugging.
3579 @c man begin SEEALSO windres
3580 the Info entries for @file{binutils}.
3589 @command{dlltool} is used to create the files needed to create dynamic
3590 link libraries (DLLs) on systems which understand PE format image
3591 files such as Windows. A DLL contains an export table which contains
3592 information that the runtime loader needs to resolve references from a
3593 referencing program.
3595 The export table is generated by this program by reading in a
3596 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3597 will be in the DLL. A @file{.o} file can contain information in
3598 special @samp{.drectve} sections with export information.
3601 @emph{Note:} @command{dlltool} is not always built as part of the
3602 binary utilities, since it is only useful for those targets which
3606 @c man title dlltool Create files needed to build and use DLLs.
3609 @c man begin SYNOPSIS dlltool
3610 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3611 [@option{-b}|@option{--base-file} @var{base-file-name}]
3612 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3613 [@option{-z}|@option{--output-def} @var{def-file-name}]
3614 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3615 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3616 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3617 [@option{--exclude-symbols} @var{list}]
3618 [@option{--no-default-excludes}]
3619 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3620 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3621 [@option{-a}|@option{--add-indirect}]
3622 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3623 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3624 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3625 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3626 [@option{--use-nul-prefixed-import-tables}]
3627 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3628 [@option{-i}|@option{--interwork}]
3629 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3630 [@option{-v}|@option{--verbose}]
3631 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3632 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
3633 [object-file @dots{}]
3637 @c man begin DESCRIPTION dlltool
3639 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3640 @option{-b} options as well as object files specified on the command
3641 line. It then processes these inputs and if the @option{-e} option has
3642 been specified it creates a exports file. If the @option{-l} option
3643 has been specified it creates a library file and if the @option{-z} option
3644 has been specified it creates a def file. Any or all of the @option{-e},
3645 @option{-l} and @option{-z} options can be present in one invocation of
3648 When creating a DLL, along with the source for the DLL, it is necessary
3649 to have three other files. @command{dlltool} can help with the creation of
3652 The first file is a @file{.def} file which specifies which functions are
3653 exported from the DLL, which functions the DLL imports, and so on. This
3654 is a text file and can be created by hand, or @command{dlltool} can be used
3655 to create it using the @option{-z} option. In this case @command{dlltool}
3656 will scan the object files specified on its command line looking for
3657 those functions which have been specially marked as being exported and
3658 put entries for them in the @file{.def} file it creates.
3660 In order to mark a function as being exported from a DLL, it needs to
3661 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3662 section of the object file. This can be done in C by using the
3666 asm (".section .drectve");
3667 asm (".ascii \"-export:my_func\"");
3669 int my_func (void) @{ @dots{} @}
3672 The second file needed for DLL creation is an exports file. This file
3673 is linked with the object files that make up the body of the DLL and it
3674 handles the interface between the DLL and the outside world. This is a
3675 binary file and it can be created by giving the @option{-e} option to
3676 @command{dlltool} when it is creating or reading in a @file{.def} file.
3678 The third file needed for DLL creation is the library file that programs
3679 will link with in order to access the functions in the DLL (an `import
3680 library'). This file can be created by giving the @option{-l} option to
3681 dlltool when it is creating or reading in a @file{.def} file.
3683 If the @option{-y} option is specified, dlltool generates a delay-import
3684 library that can be used instead of the normal import library to allow
3685 a program to link to the dll only as soon as an imported function is
3686 called for the first time. The resulting executable will need to be
3687 linked to the static delayimp library containing __delayLoadHelper2(),
3688 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
3690 @command{dlltool} builds the library file by hand, but it builds the
3691 exports file by creating temporary files containing assembler statements
3692 and then assembling these. The @option{-S} command line option can be
3693 used to specify the path to the assembler that dlltool will use,
3694 and the @option{-f} option can be used to pass specific flags to that
3695 assembler. The @option{-n} can be used to prevent dlltool from deleting
3696 these temporary assembler files when it is done, and if @option{-n} is
3697 specified twice then this will prevent dlltool from deleting the
3698 temporary object files it used to build the library.
3700 Here is an example of creating a DLL from a source file @samp{dll.c} and
3701 also creating a program (from an object file called @samp{program.o})
3706 dlltool -e exports.o -l dll.lib dll.o
3707 gcc dll.o exports.o -o dll.dll
3708 gcc program.o dll.lib -o program
3712 @command{dlltool} may also be used to query an existing import library
3713 to determine the name of the DLL to which it is associated. See the
3714 description of the @option{-I} or @option{--identify} option.
3718 @c man begin OPTIONS dlltool
3720 The command line options have the following meanings:
3724 @item -d @var{filename}
3725 @itemx --input-def @var{filename}
3726 @cindex input .def file
3727 Specifies the name of a @file{.def} file to be read in and processed.
3729 @item -b @var{filename}
3730 @itemx --base-file @var{filename}
3732 Specifies the name of a base file to be read in and processed. The
3733 contents of this file will be added to the relocation section in the
3734 exports file generated by dlltool.
3736 @item -e @var{filename}
3737 @itemx --output-exp @var{filename}
3738 Specifies the name of the export file to be created by dlltool.
3740 @item -z @var{filename}
3741 @itemx --output-def @var{filename}
3742 Specifies the name of the @file{.def} file to be created by dlltool.
3744 @item -l @var{filename}
3745 @itemx --output-lib @var{filename}
3746 Specifies the name of the library file to be created by dlltool.
3748 @item -y @var{filename}
3749 @itemx --output-delaylib @var{filename}
3750 Specifies the name of the delay-import library file to be created by dlltool.
3752 @item --export-all-symbols
3753 Treat all global and weak defined symbols found in the input object
3754 files as symbols to be exported. There is a small list of symbols which
3755 are not exported by default; see the @option{--no-default-excludes}
3756 option. You may add to the list of symbols to not export by using the
3757 @option{--exclude-symbols} option.
3759 @item --no-export-all-symbols
3760 Only export symbols explicitly listed in an input @file{.def} file or in
3761 @samp{.drectve} sections in the input object files. This is the default
3762 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3763 attributes in the source code.
3765 @item --exclude-symbols @var{list}
3766 Do not export the symbols in @var{list}. This is a list of symbol names
3767 separated by comma or colon characters. The symbol names should not
3768 contain a leading underscore. This is only meaningful when
3769 @option{--export-all-symbols} is used.
3771 @item --no-default-excludes
3772 When @option{--export-all-symbols} is used, it will by default avoid
3773 exporting certain special symbols. The current list of symbols to avoid
3774 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3775 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3776 to go ahead and export these special symbols. This is only meaningful
3777 when @option{--export-all-symbols} is used.
3780 @itemx --as @var{path}
3781 Specifies the path, including the filename, of the assembler to be used
3782 to create the exports file.
3784 @item -f @var{options}
3785 @itemx --as-flags @var{options}
3786 Specifies any specific command line options to be passed to the
3787 assembler when building the exports file. This option will work even if
3788 the @option{-S} option is not used. This option only takes one argument,
3789 and if it occurs more than once on the command line, then later
3790 occurrences will override earlier occurrences. So if it is necessary to
3791 pass multiple options to the assembler they should be enclosed in
3795 @itemx --dll-name @var{name}
3796 Specifies the name to be stored in the @file{.def} file as the name of
3797 the DLL when the @option{-e} option is used. If this option is not
3798 present, then the filename given to the @option{-e} option will be
3799 used as the name of the DLL.
3801 @item -m @var{machine}
3802 @itemx -machine @var{machine}
3803 Specifies the type of machine for which the library file should be
3804 built. @command{dlltool} has a built in default type, depending upon how
3805 it was created, but this option can be used to override that. This is
3806 normally only useful when creating DLLs for an ARM processor, when the
3807 contents of the DLL are actually encode using Thumb instructions.
3810 @itemx --add-indirect
3811 Specifies that when @command{dlltool} is creating the exports file it
3812 should add a section which allows the exported functions to be
3813 referenced without using the import library. Whatever the hell that
3817 @itemx --add-underscore
3818 Specifies that when @command{dlltool} is creating the exports file it
3819 should prepend an underscore to the names of @emph{all} exported symbols.
3821 @item --no-leading-underscore
3822 @item --leading-underscore
3823 Specifies whether standard symbol should be forced to be prefixed, or
3826 @item --add-stdcall-underscore
3827 Specifies that when @command{dlltool} is creating the exports file it
3828 should prepend an underscore to the names of exported @emph{stdcall}
3829 functions. Variable names and non-stdcall function names are not modified.
3830 This option is useful when creating GNU-compatible import libs for third
3831 party DLLs that were built with MS-Windows tools.
3835 Specifies that when @command{dlltool} is creating the exports file it
3836 should not append the string @samp{@@ <number>}. These numbers are
3837 called ordinal numbers and they represent another way of accessing the
3838 function in a DLL, other than by name.
3841 @itemx --add-stdcall-alias
3842 Specifies that when @command{dlltool} is creating the exports file it
3843 should add aliases for stdcall symbols without @samp{@@ <number>}
3844 in addition to the symbols with @samp{@@ <number>}.
3847 @itemx --ext-prefix-alias @var{prefix}
3848 Causes @command{dlltool} to create external aliases for all DLL
3849 imports with the specified prefix. The aliases are created for both
3850 external and import symbols with no leading underscore.
3854 Specifies that when @command{dlltool} is creating the exports and library
3855 files it should omit the @code{.idata4} section. This is for compatibility
3856 with certain operating systems.
3858 @item --use-nul-prefixed-import-tables
3859 Specifies that when @command{dlltool} is creating the exports and library
3860 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
3861 element. This emulates old gnu import library generation of
3862 @code{dlltool}. By default this option is turned off.
3866 Specifies that when @command{dlltool} is creating the exports and library
3867 files it should omit the @code{.idata5} section. This is for compatibility
3868 with certain operating systems.
3870 @item -I @var{filename}
3871 @itemx --identify @var{filename}
3872 Specifies that @command{dlltool} should inspect the import library
3873 indicated by @var{filename} and report, on @code{stdout}, the name(s)
3874 of the associated DLL(s). This can be performed in addition to any
3875 other operations indicated by the other options and arguments.
3876 @command{dlltool} fails if the import library does not exist or is not
3877 actually an import library. See also @option{--identify-strict}.
3879 @item --identify-strict
3880 Modifies the behavior of the @option{--identify} option, such
3881 that an error is reported if @var{filename} is associated with
3886 Specifies that @command{dlltool} should mark the objects in the library
3887 file and exports file that it produces as supporting interworking
3888 between ARM and Thumb code.
3892 Makes @command{dlltool} preserve the temporary assembler files it used to
3893 create the exports file. If this option is repeated then dlltool will
3894 also preserve the temporary object files it uses to create the library
3897 @item -t @var{prefix}
3898 @itemx --temp-prefix @var{prefix}
3899 Makes @command{dlltool} use @var{prefix} when constructing the names of
3900 temporary assembler and object files. By default, the temp file prefix
3901 is generated from the pid.
3905 Make dlltool describe what it is doing.
3909 Displays a list of command line options and then exits.
3913 Displays dlltool's version number and then exits.
3920 * def file format:: The format of the dlltool @file{.def} file
3923 @node def file format
3924 @section The format of the @command{dlltool} @file{.def} file
3926 A @file{.def} file contains any number of the following commands:
3930 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3931 The result is going to be named @var{name}@code{.exe}.
3933 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3934 The result is going to be named @var{name}@code{.dll}.
3936 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
3937 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3938 Declares @var{name1} as an exported symbol from the DLL, with optional
3939 ordinal number @var{integer}, or declares @var{name1} as an alias
3940 (forward) of the function @var{external-name} in the DLL.
3941 If @var{its_name} is specified, this name is used as string in export table.
3944 @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{]} *}
3945 Declares that @var{external-name} or the exported function whose
3946 ordinal number is @var{integer} is to be imported from the file
3947 @var{module-name}. If @var{internal-name} is specified then this is
3948 the name that the imported function will be referred to in the body of
3950 If @var{its_name} is specified, this name is used as string in import table.
3952 @item @code{DESCRIPTION} @var{string}
3953 Puts @var{string} into the output @file{.exp} file in the
3954 @code{.rdata} section.
3956 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3957 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3958 Generates @code{--stack} or @code{--heap}
3959 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
3960 section. The linker will see this and act upon it.
3962 @item @code{CODE} @var{attr} @code{+}
3963 @item @code{DATA} @var{attr} @code{+}
3964 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3965 Generates @code{--attr} @var{section-name} @var{attr} in the output
3966 @code{.drectve} section, where @var{attr} is one of @code{READ},
3967 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3968 this and act upon it.
3973 @c man begin SEEALSO dlltool
3974 The Info pages for @file{binutils}.
3981 @cindex ELF file information
3984 @c man title readelf Displays information about ELF files.
3987 @c man begin SYNOPSIS readelf
3988 readelf [@option{-a}|@option{--all}]
3989 [@option{-h}|@option{--file-header}]
3990 [@option{-l}|@option{--program-headers}|@option{--segments}]
3991 [@option{-S}|@option{--section-headers}|@option{--sections}]
3992 [@option{-g}|@option{--section-groups}]
3993 [@option{-t}|@option{--section-details}]
3994 [@option{-e}|@option{--headers}]
3995 [@option{-s}|@option{--syms}|@option{--symbols}]
3996 [@option{--dyn-syms}]
3997 [@option{-n}|@option{--notes}]
3998 [@option{-r}|@option{--relocs}]
3999 [@option{-u}|@option{--unwind}]
4000 [@option{-d}|@option{--dynamic}]
4001 [@option{-V}|@option{--version-info}]
4002 [@option{-A}|@option{--arch-specific}]
4003 [@option{-D}|@option{--use-dynamic}]
4004 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4005 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4006 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4007 [@option{-c}|@option{--archive-index}]
4008 [@option{-w[lLiaprmfFsoRt]}|
4009 @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]]
4010 [@option{--dwarf-depth=@var{n}}]
4011 [@option{--dwarf-start=@var{n}}]
4012 [@option{-I}|@option{--histogram}]
4013 [@option{-v}|@option{--version}]
4014 [@option{-W}|@option{--wide}]
4015 [@option{-H}|@option{--help}]
4016 @var{elffile}@dots{}
4020 @c man begin DESCRIPTION readelf
4022 @command{readelf} displays information about one or more ELF format object
4023 files. The options control what particular information to display.
4025 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4026 64-bit ELF files are supported, as are archives containing ELF files.
4028 This program performs a similar function to @command{objdump} but it
4029 goes into more detail and it exists independently of the @sc{bfd}
4030 library, so if there is a bug in @sc{bfd} then readelf will not be
4035 @c man begin OPTIONS readelf
4037 The long and short forms of options, shown here as alternatives, are
4038 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4044 Equivalent to specifying @option{--file-header},
4045 @option{--program-headers}, @option{--sections}, @option{--symbols},
4046 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4047 @option{--version-info}.
4050 @itemx --file-header
4051 @cindex ELF file header information
4052 Displays the information contained in the ELF header at the start of the
4056 @itemx --program-headers
4058 @cindex ELF program header information
4059 @cindex ELF segment information
4060 Displays the information contained in the file's segment headers, if it
4065 @itemx --section-headers
4066 @cindex ELF section information
4067 Displays the information contained in the file's section headers, if it
4071 @itemx --section-groups
4072 @cindex ELF section group information
4073 Displays the information contained in the file's section groups, if it
4077 @itemx --section-details
4078 @cindex ELF section information
4079 Displays the detailed section information. Implies @option{-S}.
4084 @cindex ELF symbol table information
4085 Displays the entries in symbol table section of the file, if it has one.
4088 @cindex ELF dynamic symbol table information
4089 Displays the entries in dynamic symbol table section of the file, if it
4094 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4099 Displays the contents of the NOTE segments and/or sections, if any.
4103 @cindex ELF reloc information
4104 Displays the contents of the file's relocation section, if it has one.
4108 @cindex unwind information
4109 Displays the contents of the file's unwind section, if it has one. Only
4110 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4111 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4115 @cindex ELF dynamic section information
4116 Displays the contents of the file's dynamic section, if it has one.
4119 @itemx --version-info
4120 @cindex ELF version sections informations
4121 Displays the contents of the version sections in the file, it they
4125 @itemx --arch-specific
4126 Displays architecture-specific information in the file, if there
4130 @itemx --use-dynamic
4131 When displaying symbols, this option makes @command{readelf} use the
4132 symbol hash tables in the file's dynamic section, rather than the
4133 symbol table sections.
4135 @item -x <number or name>
4136 @itemx --hex-dump=<number or name>
4137 Displays the contents of the indicated section as a hexadecimal bytes.
4138 A number identifies a particular section by index in the section table;
4139 any other string identifies all sections with that name in the object file.
4141 @item -R <number or name>
4142 @itemx --relocated-dump=<number or name>
4143 Displays the contents of the indicated section as a hexadecimal
4144 bytes. A number identifies a particular section by index in the
4145 section table; any other string identifies all sections with that name
4146 in the object file. The contents of the section will be relocated
4147 before they are displayed.
4149 @item -p <number or name>
4150 @itemx --string-dump=<number or name>
4151 Displays the contents of the indicated section as printable strings.
4152 A number identifies a particular section by index in the section table;
4153 any other string identifies all sections with that name in the object file.
4156 @itemx --archive-index
4157 @cindex Archive file symbol index information
4158 Displays the file symbol index infomation contained in the header part
4159 of binary archives. Performs the same function as the @option{t}
4160 command to @command{ar}, but without using the BFD library. @xref{ar}.
4162 @item -w[lLiaprmfFsoRt]
4163 @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]
4164 Displays the contents of the debug sections in the file, if any are
4165 present. If one of the optional letters or words follows the switch
4166 then only data found in those specific sections will be dumped.
4168 Note that there is no single letter option to display the content of
4169 trace sections or .gdb_index.
4171 Note: the @option{=decodedline} option will display the interpreted
4172 contents of a .debug_line section whereas the @option{=rawline} option
4173 dumps the contents in a raw format.
4175 Note: the @option{=frames-interp} option will display the interpreted
4176 contents of a .debug_frame section whereas the @option{=frames} option
4177 dumps the contents in a raw format.
4179 Note: the output from the @option{=info} option can also be affected
4180 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4182 @item --dwarf-depth=@var{n}
4183 Limit the dump of the @code{.debug_info} section to @var{n} children.
4184 This is only useful with @option{--debug-dump=info}. The default is
4185 to print all DIEs; the special value 0 for @var{n} will also have this
4188 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4189 levels will not be printed. The range for @var{n} is zero-based.
4191 @item --dwarf-start=@var{n}
4192 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4193 useful with @option{--debug-dump=info}.
4195 If specified, this option will suppress printing of any header
4196 information and all DIEs before the DIE numbered @var{n}. Only
4197 siblings and children of the specified DIE will be printed.
4199 This can be used in conjunction with @option{--dwarf-depth}.
4203 Display a histogram of bucket list lengths when displaying the contents
4204 of the symbol tables.
4208 Display the version number of readelf.
4212 Don't break output lines to fit into 80 columns. By default
4213 @command{readelf} breaks section header and segment listing lines for
4214 64-bit ELF files, so that they fit into 80 columns. This option causes
4215 @command{readelf} to print each section header resp. each segment one a
4216 single line, which is far more readable on terminals wider than 80 columns.
4220 Display the command line options understood by @command{readelf}.
4227 @c man begin SEEALSO readelf
4228 objdump(1), and the Info entries for @file{binutils}.
4235 @cindex Update ELF header
4238 @c man title elfedit Update the ELF header of ELF files.
4241 @c man begin SYNOPSIS elfedit
4242 elfedit [@option{--input-mach=}@var{machine}]
4243 [@option{--input-type=}@var{type}]
4244 [@option{--input-osabi=}@var{osabi}]
4245 @option{--output-mach=}@var{machine}
4246 @option{--output-type=}@var{type}
4247 @option{--output-osabi=}@var{osabi}
4248 [@option{-v}|@option{--version}]
4249 [@option{-h}|@option{--help}]
4250 @var{elffile}@dots{}
4254 @c man begin DESCRIPTION elfedit
4256 @command{elfedit} updates the ELF header of ELF files which have
4257 the matching ELF machine and file types. The options control how and
4258 which fields in the ELF header should be updated.
4260 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4261 64-bit ELF files are supported, as are archives containing ELF files.
4264 @c man begin OPTIONS elfedit
4266 The long and short forms of options, shown here as alternatives, are
4267 equivalent. At least one of the @option{--output-mach},
4268 @option{--output-type} and @option{--output-osabi} options must be given.
4272 @itemx --input-mach=@var{machine}
4273 Set the matching input ELF machine type to @var{machine}. If
4274 @option{--input-mach} isn't specified, it will match any ELF
4277 The supported ELF machine types are, @var{L1OM}, @var{K1OM} and
4280 @itemx --output-mach=@var{machine}
4281 Change the ELF machine type in the ELF header to @var{machine}. The
4282 supported ELF machine types are the same as @option{--input-mach}.
4284 @itemx --input-type=@var{type}
4285 Set the matching input ELF file type to @var{type}. If
4286 @option{--input-type} isn't specified, it will match any ELF file types.
4288 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4290 @itemx --output-type=@var{type}
4291 Change the ELF file type in the ELF header to @var{type}. The
4292 supported ELF types are the same as @option{--input-type}.
4294 @itemx --input-osabi=@var{osabi}
4295 Set the matching input ELF file OSABI to @var{osabi}. If
4296 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4298 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4299 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4300 @var{Solaris}, @var{AIX}, @var{Irix},
4301 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4302 @var{NSK}, @var{AROS} and @var{FenixOS}.
4304 @itemx --output-osabi=@var{osabi}
4305 Change the ELF OSABI in the ELF header to @var{osabi}. The
4306 supported ELF OSABI are the same as @option{--input-osabi}.
4310 Display the version number of @command{elfedit}.
4314 Display the command line options understood by @command{elfedit}.
4321 @c man begin SEEALSO elfedit
4322 readelf(1), and the Info entries for @file{binutils}.
4326 @node Common Options
4327 @chapter Common Options
4329 The following command-line options are supported by all of the
4330 programs described in this manual.
4332 @c man begin OPTIONS
4334 @include at-file.texi
4338 Display the command-line options supported by the program.
4341 Display the version number of the program.
4343 @c man begin OPTIONS
4347 @node Selecting the Target System
4348 @chapter Selecting the Target System
4350 You can specify two aspects of the target system to the @sc{gnu}
4351 binary file utilities, each in several ways:
4361 In the following summaries, the lists of ways to specify values are in
4362 order of decreasing precedence. The ways listed first override those
4365 The commands to list valid values only list the values for which the
4366 programs you are running were configured. If they were configured with
4367 @option{--enable-targets=all}, the commands list most of the available
4368 values, but a few are left out; not all targets can be configured in at
4369 once because some of them can only be configured @dfn{native} (on hosts
4370 with the same type as the target system).
4373 * Target Selection::
4374 * Architecture Selection::
4377 @node Target Selection
4378 @section Target Selection
4380 A @dfn{target} is an object file format. A given target may be
4381 supported for multiple architectures (@pxref{Architecture Selection}).
4382 A target selection may also have variations for different operating
4383 systems or architectures.
4385 The command to list valid target values is @samp{objdump -i}
4386 (the first column of output contains the relevant information).
4388 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4389 @samp{a.out-sunos-big}.
4391 You can also specify a target using a configuration triplet. This is
4392 the same sort of name that is passed to @file{configure} to specify a
4393 target. When you use a configuration triplet as an argument, it must be
4394 fully canonicalized. You can see the canonical version of a triplet by
4395 running the shell script @file{config.sub} which is included with the
4398 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4399 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4401 @subheading @command{objdump} Target
4407 command line option: @option{-b} or @option{--target}
4410 environment variable @code{GNUTARGET}
4413 deduced from the input file
4416 @subheading @command{objcopy} and @command{strip} Input Target
4422 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4425 environment variable @code{GNUTARGET}
4428 deduced from the input file
4431 @subheading @command{objcopy} and @command{strip} Output Target
4437 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4440 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4443 environment variable @code{GNUTARGET}
4446 deduced from the input file
4449 @subheading @command{nm}, @command{size}, and @command{strings} Target
4455 command line option: @option{--target}
4458 environment variable @code{GNUTARGET}
4461 deduced from the input file
4464 @node Architecture Selection
4465 @section Architecture Selection
4467 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4468 to run. Its name may contain a colon, separating the name of the
4469 processor family from the name of the particular @sc{cpu}.
4471 The command to list valid architecture values is @samp{objdump -i} (the
4472 second column contains the relevant information).
4474 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4476 @subheading @command{objdump} Architecture
4482 command line option: @option{-m} or @option{--architecture}
4485 deduced from the input file
4488 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4494 deduced from the input file
4497 @node Reporting Bugs
4498 @chapter Reporting Bugs
4500 @cindex reporting bugs
4502 Your bug reports play an essential role in making the binary utilities
4505 Reporting a bug may help you by bringing a solution to your problem, or
4506 it may not. But in any case the principal function of a bug report is
4507 to help the entire community by making the next version of the binary
4508 utilities work better. Bug reports are your contribution to their
4511 In order for a bug report to serve its purpose, you must include the
4512 information that enables us to fix the bug.
4515 * Bug Criteria:: Have you found a bug?
4516 * Bug Reporting:: How to report bugs
4520 @section Have You Found a Bug?
4521 @cindex bug criteria
4523 If you are not sure whether you have found a bug, here are some guidelines:
4526 @cindex fatal signal
4529 If a binary utility gets a fatal signal, for any input whatever, that is
4530 a bug. Reliable utilities never crash.
4532 @cindex error on valid input
4534 If a binary utility produces an error message for valid input, that is a
4538 If you are an experienced user of binary utilities, your suggestions for
4539 improvement are welcome in any case.
4543 @section How to Report Bugs
4545 @cindex bugs, reporting
4547 A number of companies and individuals offer support for @sc{gnu}
4548 products. If you obtained the binary utilities from a support
4549 organization, we recommend you contact that organization first.
4551 You can find contact information for many support companies and
4552 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4556 In any event, we also recommend that you send bug reports for the binary
4557 utilities to @value{BUGURL}.
4560 The fundamental principle of reporting bugs usefully is this:
4561 @strong{report all the facts}. If you are not sure whether to state a
4562 fact or leave it out, state it!
4564 Often people omit facts because they think they know what causes the
4565 problem and assume that some details do not matter. Thus, you might
4566 assume that the name of a file you use in an example does not matter.
4567 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4568 a stray memory reference which happens to fetch from the location where
4569 that pathname is stored in memory; perhaps, if the pathname were
4570 different, the contents of that location would fool the utility into
4571 doing the right thing despite the bug. Play it safe and give a
4572 specific, complete example. That is the easiest thing for you to do,
4573 and the most helpful.
4575 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4576 it is new to us. Therefore, always write your bug reports on the assumption
4577 that the bug has not been reported previously.
4579 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4580 bell?'' This cannot help us fix a bug, so it is basically useless. We
4581 respond by asking for enough details to enable us to investigate.
4582 You might as well expedite matters by sending them to begin with.
4584 To enable us to fix the bug, you should include all these things:
4588 The version of the utility. Each utility announces it if you start it
4589 with the @option{--version} argument.
4591 Without this, we will not know whether there is any point in looking for
4592 the bug in the current version of the binary utilities.
4595 Any patches you may have applied to the source, including any patches
4596 made to the @code{BFD} library.
4599 The type of machine you are using, and the operating system name and
4603 What compiler (and its version) was used to compile the utilities---e.g.
4607 The command arguments you gave the utility to observe the bug. To
4608 guarantee you will not omit something important, list them all. A copy
4609 of the Makefile (or the output from make) is sufficient.
4611 If we were to try to guess the arguments, we would probably guess wrong
4612 and then we might not encounter the bug.
4615 A complete input file, or set of input files, that will reproduce the
4616 bug. If the utility is reading an object file or files, then it is
4617 generally most helpful to send the actual object files.
4619 If the source files were produced exclusively using @sc{gnu} programs
4620 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4621 may be OK to send the source files rather than the object files. In
4622 this case, be sure to say exactly what version of @command{gcc}, or
4623 whatever, was used to produce the object files. Also say how
4624 @command{gcc}, or whatever, was configured.
4627 A description of what behavior you observe that you believe is
4628 incorrect. For example, ``It gets a fatal signal.''
4630 Of course, if the bug is that the utility gets a fatal signal, then we
4631 will certainly notice it. But if the bug is incorrect output, we might
4632 not notice unless it is glaringly wrong. You might as well not give us
4633 a chance to make a mistake.
4635 Even if the problem you experience is a fatal signal, you should still
4636 say so explicitly. Suppose something strange is going on, such as your
4637 copy of the utility is out of sync, or you have encountered a bug in
4638 the C library on your system. (This has happened!) Your copy might
4639 crash and ours would not. If you told us to expect a crash, then when
4640 ours fails to crash, we would know that the bug was not happening for
4641 us. If you had not told us to expect a crash, then we would not be able
4642 to draw any conclusion from our observations.
4645 If you wish to suggest changes to the source, send us context diffs, as
4646 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4647 option. Always send diffs from the old file to the new file. If you
4648 wish to discuss something in the @command{ld} source, refer to it by
4649 context, not by line number.
4651 The line numbers in our development sources will not match those in your
4652 sources. Your line numbers would convey no useful information to us.
4655 Here are some things that are not necessary:
4659 A description of the envelope of the bug.
4661 Often people who encounter a bug spend a lot of time investigating
4662 which changes to the input file will make the bug go away and which
4663 changes will not affect it.
4665 This is often time consuming and not very useful, because the way we
4666 will find the bug is by running a single example under the debugger
4667 with breakpoints, not by pure deduction from a series of examples.
4668 We recommend that you save your time for something else.
4670 Of course, if you can find a simpler example to report @emph{instead}
4671 of the original one, that is a convenience for us. Errors in the
4672 output will be easier to spot, running under the debugger will take
4673 less time, and so on.
4675 However, simplification is not vital; if you do not want to do this,
4676 report the bug anyway and send us the entire test case you used.
4679 A patch for the bug.
4681 A patch for the bug does help us if it is a good one. But do not omit
4682 the necessary information, such as the test case, on the assumption that
4683 a patch is all we need. We might see problems with your patch and decide
4684 to fix the problem another way, or we might not understand it at all.
4686 Sometimes with programs as complicated as the binary utilities it is
4687 very hard to construct an example that will make the program follow a
4688 certain path through the code. If you do not send us the example, we
4689 will not be able to construct one, so we will not be able to verify that
4692 And if we cannot understand what bug you are trying to fix, or why your
4693 patch should be an improvement, we will not install it. A test case will
4694 help us to understand.
4697 A guess about what the bug is or what it depends on.
4699 Such guesses are usually wrong. Even we cannot guess right about such
4700 things without first using the debugger to find the facts.
4703 @node GNU Free Documentation License
4704 @appendix GNU Free Documentation License
4708 @node Binutils Index
4709 @unnumbered Binutils Index