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 @kindex --enable-deterministic-archives
422 Operate in @emph{deterministic} mode. When adding files and the archive
423 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
424 for all files. When this option is used, if @command{ar} is used with
425 identical options and identical input files, multiple runs will create
426 identical output files regardless of the input files' owners, groups,
427 file modes, or modification times.
429 If @file{binutils} was configured with
430 @option{--enable-deterministic-archives}, then this mode is on by default.
431 It can be disabled with the @samp{U} modifier, below.
434 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
435 names of any length. This will cause it to create archives which are
436 not compatible with the native @command{ar} program on some systems. If
437 this is a concern, the @samp{f} modifier may be used to truncate file
438 names when putting them in the archive.
441 Insert new files @emph{before} an existing member of the
442 archive. If you use the modifier @samp{i}, the name of an existing archive
443 member must be present as the @var{relpos} argument, before the
444 @var{archive} specification. (same as @samp{b}).
447 This modifier is accepted but not used.
448 @c whaffor ar l modifier??? presumably compat; with
449 @c what???---doc@@cygnus.com, 25jan91
452 Uses the @var{count} parameter. This is used if there are multiple
453 entries in the archive with the same name. Extract or delete instance
454 @var{count} of the given name from the archive.
457 @cindex dates in archive
458 Preserve the @emph{original} dates of members when extracting them. If
459 you do not specify this modifier, files extracted from the archive
460 are stamped with the time of extraction.
463 Use the full path name when matching names in the archive. @sc{gnu}
464 @command{ar} can not create an archive with a full path name (such archives
465 are not POSIX complaint), but other archive creators can. This option
466 will cause @sc{gnu} @command{ar} to match file names using a complete path
467 name, which can be convenient when extracting a single file from an
468 archive created by another tool.
471 @cindex writing archive index
472 Write an object-file index into the archive, or update an existing one,
473 even if no other change is made to the archive. You may use this modifier
474 flag either with any operation, or alone. Running @samp{ar s} on an
475 archive is equivalent to running @samp{ranlib} on it.
478 @cindex not writing archive index
479 Do not generate an archive symbol table. This can speed up building a
480 large library in several steps. The resulting archive can not be used
481 with the linker. In order to build a symbol table, you must omit the
482 @samp{S} modifier on the last execution of @samp{ar}, or you must run
483 @samp{ranlib} on the archive.
486 @cindex creating thin archive
487 Make the specified @var{archive} a @emph{thin} archive. If it already
488 exists and is a regular archive, the existing members must be present
489 in the same directory as @var{archive}.
492 @cindex updating an archive
493 Normally, @samp{ar r}@dots{} inserts all files
494 listed into the archive. If you would like to insert @emph{only} those
495 of the files you list that are newer than existing members of the same
496 names, use this modifier. The @samp{u} modifier is allowed only for the
497 operation @samp{r} (replace). In particular, the combination @samp{qu} is
498 not allowed, since checking the timestamps would lose any speed
499 advantage from the operation @samp{q}.
502 @cindex deterministic archives
503 @kindex --enable-deterministic-archives
504 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
505 of the @samp{D} modifier, above: added files and the archive index will
506 get their actual UID, GID, timestamp, and file mode values.
508 This is the default unless @file{binutils} was configured with
509 @option{--enable-deterministic-archives}.
512 This modifier requests the @emph{verbose} version of an operation. Many
513 operations display additional information, such as filenames processed,
514 when the modifier @samp{v} is appended.
517 This modifier shows the version number of @command{ar}.
520 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
521 compatibility with AIX. The behaviour produced by this option is the
522 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
523 @samp{-X} options; in particular, it does not support @option{-X32}
524 which is the default for AIX @command{ar}.
526 The optional command line switch @option{--plugin} @var{name} causes
527 @command{ar} to load the plugin called @var{name} which adds support
528 for more file formats. This option is only available if the toolchain
529 has been built with plugin support enabled.
531 The optional command line switch @option{--target} @var{bfdname}
532 specifies that the archive members are in an object code format
533 different from your system's default format. See
534 @xref{Target Selection}, for more information.
539 @c man begin SEEALSO ar
540 nm(1), ranlib(1), and the Info entries for @file{binutils}.
545 @section Controlling @command{ar} with a Script
548 ar -M [ <@var{script} ]
551 @cindex MRI compatibility, @command{ar}
552 @cindex scripts, @command{ar}
553 If you use the single command-line option @samp{-M} with @command{ar}, you
554 can control its operation with a rudimentary command language. This
555 form of @command{ar} operates interactively if standard input is coming
556 directly from a terminal. During interactive use, @command{ar} prompts for
557 input (the prompt is @samp{AR >}), and continues executing even after
558 errors. If you redirect standard input to a script file, no prompts are
559 issued, and @command{ar} abandons execution (with a nonzero exit code)
562 The @command{ar} command language is @emph{not} designed to be equivalent
563 to the command-line options; in fact, it provides somewhat less control
564 over archives. The only purpose of the command language is to ease the
565 transition to @sc{gnu} @command{ar} for developers who already have scripts
566 written for the MRI ``librarian'' program.
568 The syntax for the @command{ar} command language is straightforward:
571 commands are recognized in upper or lower case; for example, @code{LIST}
572 is the same as @code{list}. In the following descriptions, commands are
573 shown in upper case for clarity.
576 a single command may appear on each line; it is the first word on the
580 empty lines are allowed, and have no effect.
583 comments are allowed; text after either of the characters @samp{*}
584 or @samp{;} is ignored.
587 Whenever you use a list of names as part of the argument to an @command{ar}
588 command, you can separate the individual names with either commas or
589 blanks. Commas are shown in the explanations below, for clarity.
592 @samp{+} is used as a line continuation character; if @samp{+} appears
593 at the end of a line, the text on the following line is considered part
594 of the current command.
597 Here are the commands you can use in @command{ar} scripts, or when using
598 @command{ar} interactively. Three of them have special significance:
600 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
601 a temporary file required for most of the other commands.
603 @code{SAVE} commits the changes so far specified by the script. Prior
604 to @code{SAVE}, commands affect only the temporary copy of the current
608 @item ADDLIB @var{archive}
609 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
610 Add all the contents of @var{archive} (or, if specified, each named
611 @var{module} from @var{archive}) to the current archive.
613 Requires prior use of @code{OPEN} or @code{CREATE}.
615 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
616 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
617 @c else like "ar q..."
618 Add each named @var{member} as a module in the current archive.
620 Requires prior use of @code{OPEN} or @code{CREATE}.
623 Discard the contents of the current archive, canceling the effect of
624 any operations since the last @code{SAVE}. May be executed (with no
625 effect) even if no current archive is specified.
627 @item CREATE @var{archive}
628 Creates an archive, and makes it the current archive (required for many
629 other commands). The new archive is created with a temporary name; it
630 is not actually saved as @var{archive} until you use @code{SAVE}.
631 You can overwrite existing archives; similarly, the contents of any
632 existing file named @var{archive} will not be destroyed until @code{SAVE}.
634 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
635 Delete each listed @var{module} from the current archive; equivalent to
636 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
638 Requires prior use of @code{OPEN} or @code{CREATE}.
640 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
641 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
642 List each named @var{module} present in @var{archive}. The separate
643 command @code{VERBOSE} specifies the form of the output: when verbose
644 output is off, output is like that of @samp{ar -t @var{archive}
645 @var{module}@dots{}}. When verbose output is on, the listing is like
646 @samp{ar -tv @var{archive} @var{module}@dots{}}.
648 Output normally goes to the standard output stream; however, if you
649 specify @var{outputfile} as a final argument, @command{ar} directs the
653 Exit from @command{ar}, with a @code{0} exit code to indicate successful
654 completion. This command does not save the output file; if you have
655 changed the current archive since the last @code{SAVE} command, those
658 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
659 Extract each named @var{module} from the current archive, writing them
660 into the current directory as separate files. Equivalent to @samp{ar -x
661 @var{archive} @var{module}@dots{}}.
663 Requires prior use of @code{OPEN} or @code{CREATE}.
666 @c FIXME Tokens but no commands???
673 Display full contents of the current archive, in ``verbose'' style
674 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
675 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
676 enhancement, rather than present for MRI compatibility.)
678 Requires prior use of @code{OPEN} or @code{CREATE}.
680 @item OPEN @var{archive}
681 Opens an existing archive for use as the current archive (required for
682 many other commands). Any changes as the result of subsequent commands
683 will not actually affect @var{archive} until you next use @code{SAVE}.
685 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
686 In the current archive, replace each existing @var{module} (named in
687 the @code{REPLACE} arguments) from files in the current working directory.
688 To execute this command without errors, both the file, and the module in
689 the current archive, must exist.
691 Requires prior use of @code{OPEN} or @code{CREATE}.
694 Toggle an internal flag governing the output from @code{DIRECTORY}.
695 When the flag is on, @code{DIRECTORY} output matches output from
696 @samp{ar -tv }@dots{}.
699 Commit your changes to the current archive, and actually save it as a
700 file with the name specified in the last @code{CREATE} or @code{OPEN}
703 Requires prior use of @code{OPEN} or @code{CREATE}.
712 The @sc{gnu} linker @command{ld} is now described in a separate manual.
713 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
721 @c man title nm list symbols from object files
724 @c man begin SYNOPSIS nm
725 nm [@option{-a}|@option{--debug-syms}]
726 [@option{-g}|@option{--extern-only}][@option{--plugin} @var{name}]
727 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
728 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
729 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
730 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
731 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
732 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
733 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
734 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
735 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
739 @c man begin DESCRIPTION nm
740 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
741 If no object files are listed as arguments, @command{nm} assumes the file
744 For each symbol, @command{nm} shows:
748 The symbol value, in the radix selected by options (see below), or
749 hexadecimal by default.
752 The symbol type. At least the following types are used; others are, as
753 well, depending on the object file format. If lowercase, the symbol is
754 usually local; if uppercase, the symbol is global (external). There
755 are however a few lowercase symbols that are shown for special global
756 symbols (@code{u}, @code{v} and @code{w}).
758 @c Some more detail on exactly what these symbol types are used for
762 The symbol's value is absolute, and will not be changed by further
767 The symbol is in the uninitialized data section (known as BSS).
770 The symbol is common. Common symbols are uninitialized data. When
771 linking, multiple common symbols may appear with the same name. If the
772 symbol is defined anywhere, the common symbols are treated as undefined
775 For more details on common symbols, see the discussion of
776 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
781 The symbol is in the initialized data section.
785 The symbol is in an initialized data section for small objects. Some
786 object file formats permit more efficient access to small data objects,
787 such as a global int variable as opposed to a large global array.
790 For PE format files this indicates that the symbol is in a section
791 specific to the implementation of DLLs. For ELF format files this
792 indicates that the symbol is an indirect function. This is a GNU
793 extension to the standard set of ELF symbol types. It indicates a
794 symbol which if referenced by a relocation does not evaluate to its
795 address, but instead must be invoked at runtime. The runtime
796 execution will then return the value to be used in the relocation.
799 The symbol is a debugging symbol.
802 The symbols is in a stack unwind section.
806 The symbol is in a read only data section.
810 The symbol is in an uninitialized data section for small objects.
814 The symbol is in the text (code) section.
817 The symbol is undefined.
820 The symbol is a unique global symbol. This is a GNU extension to the
821 standard set of ELF symbol bindings. For such a symbol the dynamic linker
822 will make sure that in the entire process there is just one symbol with
823 this name and type in use.
827 The symbol is a weak object. When a weak defined symbol is linked with
828 a normal defined symbol, the normal defined symbol is used with no error.
829 When a weak undefined symbol is linked and the symbol is not defined,
830 the value of the weak symbol becomes zero with no error. On some
831 systems, uppercase indicates that a default value has been specified.
835 The symbol is a weak symbol that has not been specifically tagged as a
836 weak object symbol. When a weak defined symbol is linked with a normal
837 defined symbol, the normal defined symbol is used with no error.
838 When a weak undefined symbol is linked and the symbol is not defined,
839 the value of the symbol is determined in a system-specific manner without
840 error. On some systems, uppercase indicates that a default value has been
844 The symbol is a stabs symbol in an a.out object file. In this case, the
845 next values printed are the stabs other field, the stabs desc field, and
846 the stab type. Stabs symbols are used to hold debugging information.
848 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
849 ``stabs'' debug format}.
853 The symbol type is unknown, or object file format specific.
862 @c man begin OPTIONS nm
863 The long and short forms of options, shown here as alternatives, are
869 @itemx --print-file-name
870 @cindex input file name
872 @cindex source file name
873 Precede each symbol by the name of the input file (or archive member)
874 in which it was found, rather than identifying the input file once only,
875 before all of its symbols.
879 @cindex debugging symbols
880 Display all symbols, even debugger-only symbols; normally these are not
884 @cindex @command{nm} format
885 @cindex @command{nm} compatibility
886 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
889 @itemx --demangle[=@var{style}]
890 @cindex demangling in nm
891 Decode (@dfn{demangle}) low-level symbol names into user-level names.
892 Besides removing any initial underscore prepended by the system, this
893 makes C++ function names readable. Different compilers have different
894 mangling styles. The optional demangling style argument can be used to
895 choose an appropriate demangling style for your compiler. @xref{c++filt},
896 for more information on demangling.
899 Do not demangle low-level symbol names. This is the default.
903 @cindex dynamic symbols
904 Display the dynamic symbols rather than the normal symbols. This is
905 only meaningful for dynamic objects, such as certain types of shared
908 @item -f @var{format}
909 @itemx --format=@var{format}
910 @cindex @command{nm} format
911 @cindex @command{nm} compatibility
912 Use the output format @var{format}, which can be @code{bsd},
913 @code{sysv}, or @code{posix}. The default is @code{bsd}.
914 Only the first character of @var{format} is significant; it can be
915 either upper or lower case.
919 @cindex external symbols
920 Display only external symbols.
922 @item --plugin @var{name}
924 Load the plugin called @var{name} to add support for extra target
925 types. This option is only available if the toolchain has been built
926 with plugin support enabled.
929 @itemx --line-numbers
930 @cindex symbol line numbers
931 For each symbol, use debugging information to try to find a filename and
932 line number. For a defined symbol, look for the line number of the
933 address of the symbol. For an undefined symbol, look for the line
934 number of a relocation entry which refers to the symbol. If line number
935 information can be found, print it after the other symbol information.
939 @itemx --numeric-sort
940 Sort symbols numerically by their addresses, rather than alphabetically
945 @cindex sorting symbols
946 Do not bother to sort the symbols in any order; print them in the order
951 Use the POSIX.2 standard output format instead of the default format.
952 Equivalent to @samp{-f posix}.
956 Print both value and size of defined symbols for the @code{bsd} output style.
957 This option has no effect for object formats that do not record symbol
958 sizes, unless @samp{--size-sort} is also used in which case a
959 calculated size is displayed.
963 @cindex symbol index, listing
964 When listing symbols from archive members, include the index: a mapping
965 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
966 contain definitions for which names.
969 @itemx --reverse-sort
970 Reverse the order of the sort (whether numeric or alphabetic); let the
974 Sort symbols by size. The size is computed as the difference between
975 the value of the symbol and the value of the symbol with the next higher
976 value. If the @code{bsd} output format is used the size of the symbol
977 is printed, rather than the value, and @samp{-S} must be used in order
978 both size and value to be printed.
981 Display symbols which have a target-specific special meaning. These
982 symbols are usually used by the target for some special processing and
983 are not normally helpful when included included in the normal symbol
984 lists. For example for ARM targets this option would skip the mapping
985 symbols used to mark transitions between ARM code, THUMB code and
989 @itemx --radix=@var{radix}
990 Use @var{radix} as the radix for printing the symbol values. It must be
991 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
993 @item --target=@var{bfdname}
994 @cindex object code format
995 Specify an object code format other than your system's default format.
996 @xref{Target Selection}, for more information.
999 @itemx --undefined-only
1000 @cindex external symbols
1001 @cindex undefined symbols
1002 Display only undefined symbols (those external to each object file).
1004 @item --defined-only
1005 @cindex external symbols
1006 @cindex undefined symbols
1007 Display only defined symbols for each object file.
1011 Show the version number of @command{nm} and exit.
1014 This option is ignored for compatibility with the AIX version of
1015 @command{nm}. It takes one parameter which must be the string
1016 @option{32_64}. The default mode of AIX @command{nm} corresponds
1017 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1020 Show a summary of the options to @command{nm} and exit.
1026 @c man begin SEEALSO nm
1027 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1034 @c man title objcopy copy and translate object files
1037 @c man begin SYNOPSIS objcopy
1038 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1039 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1040 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1041 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1042 [@option{-S}|@option{--strip-all}]
1043 [@option{-g}|@option{--strip-debug}]
1044 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1045 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1046 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1047 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1048 [@option{--localize-hidden}]
1049 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1050 [@option{--globalize-symbol=}@var{symbolname}]
1051 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1052 [@option{-w}|@option{--wildcard}]
1053 [@option{-x}|@option{--discard-all}]
1054 [@option{-X}|@option{--discard-locals}]
1055 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1056 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1057 [@option{--interleave-width=}@var{width}]
1058 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
1059 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
1060 [@option{-p}|@option{--preserve-dates}]
1061 [@option{--debugging}]
1062 [@option{--gap-fill=}@var{val}]
1063 [@option{--pad-to=}@var{address}]
1064 [@option{--set-start=}@var{val}]
1065 [@option{--adjust-start=}@var{incr}]
1066 [@option{--change-addresses=}@var{incr}]
1067 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
1068 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
1069 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
1070 [@option{--change-warnings}] [@option{--no-change-warnings}]
1071 [@option{--set-section-flags} @var{section}=@var{flags}]
1072 [@option{--add-section} @var{sectionname}=@var{filename}]
1073 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1074 [@option{--long-section-names} @{enable,disable,keep@}]
1075 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1076 [@option{--reverse-bytes=}@var{num}]
1077 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1078 [@option{--redefine-sym} @var{old}=@var{new}]
1079 [@option{--redefine-syms=}@var{filename}]
1081 [@option{--keep-symbols=}@var{filename}]
1082 [@option{--strip-symbols=}@var{filename}]
1083 [@option{--strip-unneeded-symbols=}@var{filename}]
1084 [@option{--keep-global-symbols=}@var{filename}]
1085 [@option{--localize-symbols=}@var{filename}]
1086 [@option{--globalize-symbols=}@var{filename}]
1087 [@option{--weaken-symbols=}@var{filename}]
1088 [@option{--alt-machine-code=}@var{index}]
1089 [@option{--prefix-symbols=}@var{string}]
1090 [@option{--prefix-sections=}@var{string}]
1091 [@option{--prefix-alloc-sections=}@var{string}]
1092 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1093 [@option{--keep-file-symbols}]
1094 [@option{--only-keep-debug}]
1095 [@option{--extract-symbol}]
1096 [@option{--writable-text}]
1097 [@option{--readonly-text}]
1100 [@option{--file-alignment=}@var{num}]
1101 [@option{--heap=}@var{size}]
1102 [@option{--image-base=}@var{address}]
1103 [@option{--section-alignment=}@var{num}]
1104 [@option{--stack=}@var{size}]
1105 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1106 [@option{--compress-debug-sections}]
1107 [@option{--decompress-debug-sections}]
1108 [@option{--dwarf-depth=@var{n}}]
1109 [@option{--dwarf-start=@var{n}}]
1110 [@option{-v}|@option{--verbose}]
1111 [@option{-V}|@option{--version}]
1112 [@option{--help}] [@option{--info}]
1113 @var{infile} [@var{outfile}]
1117 @c man begin DESCRIPTION objcopy
1118 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1119 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1120 read and write the object files. It can write the destination object
1121 file in a format different from that of the source object file. The
1122 exact behavior of @command{objcopy} is controlled by command-line options.
1123 Note that @command{objcopy} should be able to copy a fully linked file
1124 between any two formats. However, copying a relocatable object file
1125 between any two formats may not work as expected.
1127 @command{objcopy} creates temporary files to do its translations and
1128 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1129 translation work; it has access to all the formats described in @sc{bfd}
1130 and thus is able to recognize most formats without being told
1131 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1133 @command{objcopy} can be used to generate S-records by using an output
1134 target of @samp{srec} (e.g., use @samp{-O srec}).
1136 @command{objcopy} can be used to generate a raw binary file by using an
1137 output target of @samp{binary} (e.g., use @option{-O binary}). When
1138 @command{objcopy} generates a raw binary file, it will essentially produce
1139 a memory dump of the contents of the input object file. All symbols and
1140 relocation information will be discarded. The memory dump will start at
1141 the load address of the lowest section copied into the output file.
1143 When generating an S-record or a raw binary file, it may be helpful to
1144 use @option{-S} to remove sections containing debugging information. In
1145 some cases @option{-R} will be useful to remove sections which contain
1146 information that is not needed by the binary file.
1148 Note---@command{objcopy} is not able to change the endianness of its input
1149 files. If the input format has an endianness (some formats do not),
1150 @command{objcopy} can only copy the inputs into file formats that have the
1151 same endianness or which have no endianness (e.g., @samp{srec}).
1152 (However, see the @option{--reverse-bytes} option.)
1156 @c man begin OPTIONS objcopy
1160 @itemx @var{outfile}
1161 The input and output files, respectively.
1162 If you do not specify @var{outfile}, @command{objcopy} creates a
1163 temporary file and destructively renames the result with
1164 the name of @var{infile}.
1166 @item -I @var{bfdname}
1167 @itemx --input-target=@var{bfdname}
1168 Consider the source file's object format to be @var{bfdname}, rather than
1169 attempting to deduce it. @xref{Target Selection}, for more information.
1171 @item -O @var{bfdname}
1172 @itemx --output-target=@var{bfdname}
1173 Write the output file using the object format @var{bfdname}.
1174 @xref{Target Selection}, for more information.
1176 @item -F @var{bfdname}
1177 @itemx --target=@var{bfdname}
1178 Use @var{bfdname} as the object format for both the input and the output
1179 file; i.e., simply transfer data from source to destination with no
1180 translation. @xref{Target Selection}, for more information.
1182 @item -B @var{bfdarch}
1183 @itemx --binary-architecture=@var{bfdarch}
1184 Useful when transforming a architecture-less input file into an object file.
1185 In this case the output architecture can be set to @var{bfdarch}. This
1186 option will be ignored if the input file has a known @var{bfdarch}. You
1187 can access this binary data inside a program by referencing the special
1188 symbols that are created by the conversion process. These symbols are
1189 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1190 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1191 an object file and then access it in your code using these symbols.
1193 @item -j @var{sectionname}
1194 @itemx --only-section=@var{sectionname}
1195 Copy only the named section from the input file to the output file.
1196 This option may be given more than once. Note that using this option
1197 inappropriately may make the output file unusable.
1199 @item -R @var{sectionname}
1200 @itemx --remove-section=@var{sectionname}
1201 Remove any section named @var{sectionname} from the output file. This
1202 option may be given more than once. Note that using this option
1203 inappropriately may make the output file unusable.
1207 Do not copy relocation and symbol information from the source file.
1210 @itemx --strip-debug
1211 Do not copy debugging symbols or sections from the source file.
1213 @item --strip-unneeded
1214 Strip all symbols that are not needed for relocation processing.
1216 @item -K @var{symbolname}
1217 @itemx --keep-symbol=@var{symbolname}
1218 When stripping symbols, keep symbol @var{symbolname} even if it would
1219 normally be stripped. This option may be given more than once.
1221 @item -N @var{symbolname}
1222 @itemx --strip-symbol=@var{symbolname}
1223 Do not copy symbol @var{symbolname} from the source file. This option
1224 may be given more than once.
1226 @item --strip-unneeded-symbol=@var{symbolname}
1227 Do not copy symbol @var{symbolname} from the source file unless it is needed
1228 by a relocation. This option may be given more than once.
1230 @item -G @var{symbolname}
1231 @itemx --keep-global-symbol=@var{symbolname}
1232 Keep only symbol @var{symbolname} global. Make all other symbols local
1233 to the file, so that they are not visible externally. This option may
1234 be given more than once.
1236 @item --localize-hidden
1237 In an ELF object, mark all symbols that have hidden or internal visibility
1238 as local. This option applies on top of symbol-specific localization options
1239 such as @option{-L}.
1241 @item -L @var{symbolname}
1242 @itemx --localize-symbol=@var{symbolname}
1243 Make symbol @var{symbolname} local to the file, so that it is not
1244 visible externally. This option may be given more than once.
1246 @item -W @var{symbolname}
1247 @itemx --weaken-symbol=@var{symbolname}
1248 Make symbol @var{symbolname} weak. This option may be given more than once.
1250 @item --globalize-symbol=@var{symbolname}
1251 Give symbol @var{symbolname} global scoping so that it is visible
1252 outside of the file in which it is defined. This option may be given
1257 Permit regular expressions in @var{symbolname}s used in other command
1258 line options. The question mark (?), asterisk (*), backslash (\) and
1259 square brackets ([]) operators can be used anywhere in the symbol
1260 name. If the first character of the symbol name is the exclamation
1261 point (!) then the sense of the switch is reversed for that symbol.
1268 would cause objcopy to weaken all symbols that start with ``fo''
1269 except for the symbol ``foo''.
1272 @itemx --discard-all
1273 Do not copy non-global symbols from the source file.
1274 @c FIXME any reason to prefer "non-global" to "local" here?
1277 @itemx --discard-locals
1278 Do not copy compiler-generated local symbols.
1279 (These usually start with @samp{L} or @samp{.}.)
1282 @itemx --byte=@var{byte}
1283 If interleaving has been enabled via the @option{--interleave} option
1284 then start the range of bytes to keep at the @var{byte}th byte.
1285 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1286 @var{breadth} is the value given by the @option{--interleave} option.
1288 @item -i [@var{breadth}]
1289 @itemx --interleave[=@var{breadth}]
1290 Only copy a range out of every @var{breadth} bytes. (Header data is
1291 not affected). Select which byte in the range begins the copy with
1292 the @option{--byte} option. Select the width of the range with the
1293 @option{--interleave-width} option.
1295 This option is useful for creating files to program @sc{rom}. It is
1296 typically used with an @code{srec} output target. Note that
1297 @command{objcopy} will complain if you do not specify the
1298 @option{--byte} option as well.
1300 The default interleave breadth is 4, so with @option{--byte} set to 0,
1301 @command{objcopy} would copy the first byte out of every four bytes
1302 from the input to the output.
1304 @item --interleave-width=@var{width}
1305 When used with the @option{--interleave} option, copy @var{width}
1306 bytes at a time. The start of the range of bytes to be copied is set
1307 by the @option{--byte} option, and the extent of the range is set with
1308 the @option{--interleave} option.
1310 The default value for this option is 1. The value of @var{width} plus
1311 the @var{byte} value set by the @option{--byte} option must not exceed
1312 the interleave breadth set by the @option{--interleave} option.
1314 This option can be used to create images for two 16-bit flashes interleaved
1315 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1316 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1317 commands. If the input was '12345678' then the outputs would be
1318 '1256' and '3478' respectively.
1321 @itemx --preserve-dates
1322 Set the access and modification dates of the output file to be the same
1323 as those of the input file.
1326 Convert debugging information, if possible. This is not the default
1327 because only certain debugging formats are supported, and the
1328 conversion process can be time consuming.
1330 @item --gap-fill @var{val}
1331 Fill gaps between sections with @var{val}. This operation applies to
1332 the @emph{load address} (LMA) of the sections. It is done by increasing
1333 the size of the section with the lower address, and filling in the extra
1334 space created with @var{val}.
1336 @item --pad-to @var{address}
1337 Pad the output file up to the load address @var{address}. This is
1338 done by increasing the size of the last section. The extra space is
1339 filled in with the value specified by @option{--gap-fill} (default zero).
1341 @item --set-start @var{val}
1342 Set the start address of the new file to @var{val}. Not all object file
1343 formats support setting the start address.
1345 @item --change-start @var{incr}
1346 @itemx --adjust-start @var{incr}
1347 @cindex changing start address
1348 Change the start address by adding @var{incr}. Not all object file
1349 formats support setting the start address.
1351 @item --change-addresses @var{incr}
1352 @itemx --adjust-vma @var{incr}
1353 @cindex changing object addresses
1354 Change the VMA and LMA addresses of all sections, as well as the start
1355 address, by adding @var{incr}. Some object file formats do not permit
1356 section addresses to be changed arbitrarily. Note that this does not
1357 relocate the sections; if the program expects sections to be loaded at a
1358 certain address, and this option is used to change the sections such
1359 that they are loaded at a different address, the program may fail.
1361 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1362 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1363 @cindex changing section address
1364 Set or change both the VMA address and the LMA address of the named
1365 @var{section}. If @samp{=} is used, the section address is set to
1366 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1367 section address. See the comments under @option{--change-addresses},
1368 above. If @var{section} does not exist in the input file, a warning will
1369 be issued, unless @option{--no-change-warnings} is used.
1371 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1372 @cindex changing section LMA
1373 Set or change the LMA address of the named @var{section}. The LMA
1374 address is the address where the section will be loaded into memory at
1375 program load time. Normally this is the same as the VMA address, which
1376 is the address of the section at program run time, but on some systems,
1377 especially those where a program is held in ROM, the two can be
1378 different. If @samp{=} is used, the section address is set to
1379 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1380 section address. See the comments under @option{--change-addresses},
1381 above. If @var{section} does not exist in the input file, a warning
1382 will be issued, unless @option{--no-change-warnings} is used.
1384 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1385 @cindex changing section VMA
1386 Set or change the VMA address of the named @var{section}. The VMA
1387 address is the address where the section will be located once the
1388 program has started executing. Normally this is the same as the LMA
1389 address, which is the address where the section will be loaded into
1390 memory, but on some systems, especially those where a program is held in
1391 ROM, the two can be different. If @samp{=} is used, the section address
1392 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1393 from the section address. See the comments under
1394 @option{--change-addresses}, above. If @var{section} does not exist in
1395 the input file, a warning will be issued, unless
1396 @option{--no-change-warnings} is used.
1398 @item --change-warnings
1399 @itemx --adjust-warnings
1400 If @option{--change-section-address} or @option{--change-section-lma} or
1401 @option{--change-section-vma} is used, and the named section does not
1402 exist, issue a warning. This is the default.
1404 @item --no-change-warnings
1405 @itemx --no-adjust-warnings
1406 Do not issue a warning if @option{--change-section-address} or
1407 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1408 if the named section does not exist.
1410 @item --set-section-flags @var{section}=@var{flags}
1411 Set the flags for the named section. The @var{flags} argument is a
1412 comma separated string of flag names. The recognized names are
1413 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1414 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1415 @samp{debug}. You can set the @samp{contents} flag for a section which
1416 does not have contents, but it is not meaningful to clear the
1417 @samp{contents} flag of a section which does have contents--just remove
1418 the section instead. Not all flags are meaningful for all object file
1421 @item --add-section @var{sectionname}=@var{filename}
1422 Add a new section named @var{sectionname} while copying the file. The
1423 contents of the new section are taken from the file @var{filename}. The
1424 size of the section will be the size of the file. This option only
1425 works on file formats which can support sections with arbitrary names.
1427 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1428 Rename a section from @var{oldname} to @var{newname}, optionally
1429 changing the section's flags to @var{flags} in the process. This has
1430 the advantage over usng a linker script to perform the rename in that
1431 the output stays as an object file and does not become a linked
1434 This option is particularly helpful when the input format is binary,
1435 since this will always create a section called .data. If for example,
1436 you wanted instead to create a section called .rodata containing binary
1437 data you could use the following command line to achieve it:
1440 objcopy -I binary -O <output_format> -B <architecture> \
1441 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1442 <input_binary_file> <output_object_file>
1445 @item --long-section-names @{enable,disable,keep@}
1446 Controls the handling of long section names when processing @code{COFF}
1447 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1448 is to preserve long section names if any are present in the input file.
1449 The @samp{enable} and @samp{disable} options forcibly enable or disable
1450 the use of long section names in the output object; when @samp{disable}
1451 is in effect, any long section names in the input object will be truncated.
1452 The @samp{enable} option will only emit long section names if any are
1453 present in the inputs; this is mostly the same as @samp{keep}, but it
1454 is left undefined whether the @samp{enable} option might force the
1455 creation of an empty string table in the output file.
1457 @item --change-leading-char
1458 Some object file formats use special characters at the start of
1459 symbols. The most common such character is underscore, which compilers
1460 often add before every symbol. This option tells @command{objcopy} to
1461 change the leading character of every symbol when it converts between
1462 object file formats. If the object file formats use the same leading
1463 character, this option has no effect. Otherwise, it will add a
1464 character, or remove a character, or change a character, as
1467 @item --remove-leading-char
1468 If the first character of a global symbol is a special symbol leading
1469 character used by the object file format, remove the character. The
1470 most common symbol leading character is underscore. This option will
1471 remove a leading underscore from all global symbols. This can be useful
1472 if you want to link together objects of different file formats with
1473 different conventions for symbol names. This is different from
1474 @option{--change-leading-char} because it always changes the symbol name
1475 when appropriate, regardless of the object file format of the output
1478 @item --reverse-bytes=@var{num}
1479 Reverse the bytes in a section with output contents. A section length must
1480 be evenly divisible by the value given in order for the swap to be able to
1481 take place. Reversing takes place before the interleaving is performed.
1483 This option is used typically in generating ROM images for problematic
1484 target systems. For example, on some target boards, the 32-bit words
1485 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1486 regardless of the CPU byte order. Depending on the programming model, the
1487 endianness of the ROM may need to be modified.
1489 Consider a simple file with a section containing the following eight
1490 bytes: @code{12345678}.
1492 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1493 output file would be ordered @code{21436587}.
1495 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1496 output file would be ordered @code{43218765}.
1498 By using @samp{--reverse-bytes=2} for the above example, followed by
1499 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1500 output file would be ordered @code{34127856}.
1502 @item --srec-len=@var{ival}
1503 Meaningful only for srec output. Set the maximum length of the Srecords
1504 being produced to @var{ival}. This length covers both address, data and
1507 @item --srec-forceS3
1508 Meaningful only for srec output. Avoid generation of S1/S2 records,
1509 creating S3-only record format.
1511 @item --redefine-sym @var{old}=@var{new}
1512 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1513 when one is trying link two things together for which you have no
1514 source, and there are name collisions.
1516 @item --redefine-syms=@var{filename}
1517 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1518 listed in the file @var{filename}. @var{filename} is simply a flat file,
1519 with one symbol pair per line. Line comments may be introduced by the hash
1520 character. This option may be given more than once.
1523 Change all global symbols in the file to be weak. This can be useful
1524 when building an object which will be linked against other objects using
1525 the @option{-R} option to the linker. This option is only effective when
1526 using an object file format which supports weak symbols.
1528 @item --keep-symbols=@var{filename}
1529 Apply @option{--keep-symbol} option to each symbol listed in the file
1530 @var{filename}. @var{filename} is simply a flat file, with one symbol
1531 name per line. Line comments may be introduced by the hash character.
1532 This option may be given more than once.
1534 @item --strip-symbols=@var{filename}
1535 Apply @option{--strip-symbol} option to each symbol listed in the file
1536 @var{filename}. @var{filename} is simply a flat file, with one symbol
1537 name per line. Line comments may be introduced by the hash character.
1538 This option may be given more than once.
1540 @item --strip-unneeded-symbols=@var{filename}
1541 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1542 the file @var{filename}. @var{filename} is simply a flat file, with one
1543 symbol name per line. Line comments may be introduced by the hash
1544 character. This option may be given more than once.
1546 @item --keep-global-symbols=@var{filename}
1547 Apply @option{--keep-global-symbol} option to each symbol listed in the
1548 file @var{filename}. @var{filename} is simply a flat file, with one
1549 symbol name per line. Line comments may be introduced by the hash
1550 character. This option may be given more than once.
1552 @item --localize-symbols=@var{filename}
1553 Apply @option{--localize-symbol} option to each symbol listed in the file
1554 @var{filename}. @var{filename} is simply a flat file, with one symbol
1555 name per line. Line comments may be introduced by the hash character.
1556 This option may be given more than once.
1558 @item --globalize-symbols=@var{filename}
1559 Apply @option{--globalize-symbol} option to each symbol listed in the file
1560 @var{filename}. @var{filename} is simply a flat file, with one symbol
1561 name per line. Line comments may be introduced by the hash character.
1562 This option may be given more than once.
1564 @item --weaken-symbols=@var{filename}
1565 Apply @option{--weaken-symbol} option to each symbol listed in the file
1566 @var{filename}. @var{filename} is simply a flat file, with one symbol
1567 name per line. Line comments may be introduced by the hash character.
1568 This option may be given more than once.
1570 @item --alt-machine-code=@var{index}
1571 If the output architecture has alternate machine codes, use the
1572 @var{index}th code instead of the default one. This is useful in case
1573 a machine is assigned an official code and the tool-chain adopts the
1574 new code, but other applications still depend on the original code
1575 being used. For ELF based architectures if the @var{index}
1576 alternative does not exist then the value is treated as an absolute
1577 number to be stored in the e_machine field of the ELF header.
1579 @item --writable-text
1580 Mark the output text as writable. This option isn't meaningful for all
1581 object file formats.
1583 @item --readonly-text
1584 Make the output text write protected. This option isn't meaningful for all
1585 object file formats.
1588 Mark the output file as demand paged. This option isn't meaningful for all
1589 object file formats.
1592 Mark the output file as impure. This option isn't meaningful for all
1593 object file formats.
1595 @item --prefix-symbols=@var{string}
1596 Prefix all symbols in the output file with @var{string}.
1598 @item --prefix-sections=@var{string}
1599 Prefix all section names in the output file with @var{string}.
1601 @item --prefix-alloc-sections=@var{string}
1602 Prefix all the names of all allocated sections in the output file with
1605 @item --add-gnu-debuglink=@var{path-to-file}
1606 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1607 and adds it to the output file.
1609 @item --keep-file-symbols
1610 When stripping a file, perhaps with @option{--strip-debug} or
1611 @option{--strip-unneeded}, retain any symbols specifying source file names,
1612 which would otherwise get stripped.
1614 @item --only-keep-debug
1615 Strip a file, removing contents of any sections that would not be
1616 stripped by @option{--strip-debug} and leaving the debugging sections
1617 intact. In ELF files, this preserves all note sections in the output.
1619 The intention is that this option will be used in conjunction with
1620 @option{--add-gnu-debuglink} to create a two part executable. One a
1621 stripped binary which will occupy less space in RAM and in a
1622 distribution and the second a debugging information file which is only
1623 needed if debugging abilities are required. The suggested procedure
1624 to create these files is as follows:
1627 @item Link the executable as normal. Assuming that is is called
1629 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1630 create a file containing the debugging info.
1631 @item Run @code{objcopy --strip-debug foo} to create a
1632 stripped executable.
1633 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1634 to add a link to the debugging info into the stripped executable.
1637 Note---the choice of @code{.dbg} as an extension for the debug info
1638 file is arbitrary. Also the @code{--only-keep-debug} step is
1639 optional. You could instead do this:
1642 @item Link the executable as normal.
1643 @item Copy @code{foo} to @code{foo.full}
1644 @item Run @code{objcopy --strip-debug foo}
1645 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1648 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1649 full executable. It does not have to be a file created by the
1650 @option{--only-keep-debug} switch.
1652 Note---this switch is only intended for use on fully linked files. It
1653 does not make sense to use it on object files where the debugging
1654 information may be incomplete. Besides the gnu_debuglink feature
1655 currently only supports the presence of one filename containing
1656 debugging information, not multiple filenames on a one-per-object-file
1659 @item --file-alignment @var{num}
1660 Specify the file alignment. Sections in the file will always begin at
1661 file offsets which are multiples of this number. This defaults to
1663 [This option is specific to PE targets.]
1665 @item --heap @var{reserve}
1666 @itemx --heap @var{reserve},@var{commit}
1667 Specify the number of bytes of memory to reserve (and optionally commit)
1668 to be used as heap for this program.
1669 [This option is specific to PE targets.]
1671 @item --image-base @var{value}
1672 Use @var{value} as the base address of your program or dll. This is
1673 the lowest memory location that will be used when your program or dll
1674 is loaded. To reduce the need to relocate and improve performance of
1675 your dlls, each should have a unique base address and not overlap any
1676 other dlls. The default is 0x400000 for executables, and 0x10000000
1678 [This option is specific to PE targets.]
1680 @item --section-alignment @var{num}
1681 Sets the section alignment. Sections in memory will always begin at
1682 addresses which are a multiple of this number. Defaults to 0x1000.
1683 [This option is specific to PE targets.]
1685 @item --stack @var{reserve}
1686 @itemx --stack @var{reserve},@var{commit}
1687 Specify the number of bytes of memory to reserve (and optionally commit)
1688 to be used as stack for this program.
1689 [This option is specific to PE targets.]
1691 @item --subsystem @var{which}
1692 @itemx --subsystem @var{which}:@var{major}
1693 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1694 Specifies the subsystem under which your program will execute. The
1695 legal values for @var{which} are @code{native}, @code{windows},
1696 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1697 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1698 the subsystem version also. Numeric values are also accepted for
1700 [This option is specific to PE targets.]
1702 @item --extract-symbol
1703 Keep the file's section flags and symbols but remove all section data.
1704 Specifically, the option:
1707 @item removes the contents of all sections;
1708 @item sets the size of every section to zero; and
1709 @item sets the file's start address to zero.
1712 This option is used to build a @file{.sym} file for a VxWorks kernel.
1713 It can also be a useful way of reducing the size of a @option{--just-symbols}
1716 @item --compress-debug-sections
1717 Compress DWARF debug sections using zlib.
1719 @item --decompress-debug-sections
1720 Decompress DWARF debug sections using zlib.
1724 Show the version number of @command{objcopy}.
1728 Verbose output: list all object files modified. In the case of
1729 archives, @samp{objcopy -V} lists all members of the archive.
1732 Show a summary of the options to @command{objcopy}.
1735 Display a list showing all architectures and object formats available.
1741 @c man begin SEEALSO objcopy
1742 ld(1), objdump(1), and the Info entries for @file{binutils}.
1749 @cindex object file information
1752 @c man title objdump display information from object files.
1755 @c man begin SYNOPSIS objdump
1756 objdump [@option{-a}|@option{--archive-headers}]
1757 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1758 [@option{-C}|@option{--demangle}[=@var{style}] ]
1759 [@option{-d}|@option{--disassemble}]
1760 [@option{-D}|@option{--disassemble-all}]
1761 [@option{-z}|@option{--disassemble-zeroes}]
1762 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1763 [@option{-f}|@option{--file-headers}]
1764 [@option{-F}|@option{--file-offsets}]
1765 [@option{--file-start-context}]
1766 [@option{-g}|@option{--debugging}]
1767 [@option{-e}|@option{--debugging-tags}]
1768 [@option{-h}|@option{--section-headers}|@option{--headers}]
1769 [@option{-i}|@option{--info}]
1770 [@option{-j} @var{section}|@option{--section=}@var{section}]
1771 [@option{-l}|@option{--line-numbers}]
1772 [@option{-S}|@option{--source}]
1773 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1774 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1775 [@option{-p}|@option{--private-headers}]
1776 [@option{-P} @var{options}|@option{--private=}@var{options}]
1777 [@option{-r}|@option{--reloc}]
1778 [@option{-R}|@option{--dynamic-reloc}]
1779 [@option{-s}|@option{--full-contents}]
1780 [@option{-W[lLiaprmfFsoRt]}|
1781 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
1782 [@option{-G}|@option{--stabs}]
1783 [@option{-t}|@option{--syms}]
1784 [@option{-T}|@option{--dynamic-syms}]
1785 [@option{-x}|@option{--all-headers}]
1786 [@option{-w}|@option{--wide}]
1787 [@option{--start-address=}@var{address}]
1788 [@option{--stop-address=}@var{address}]
1789 [@option{--prefix-addresses}]
1790 [@option{--[no-]show-raw-insn}]
1791 [@option{--adjust-vma=}@var{offset}]
1792 [@option{--special-syms}]
1793 [@option{--prefix=}@var{prefix}]
1794 [@option{--prefix-strip=}@var{level}]
1795 [@option{--insn-width=}@var{width}]
1796 [@option{-V}|@option{--version}]
1797 [@option{-H}|@option{--help}]
1798 @var{objfile}@dots{}
1802 @c man begin DESCRIPTION objdump
1804 @command{objdump} displays information about one or more object files.
1805 The options control what particular information to display. This
1806 information is mostly useful to programmers who are working on the
1807 compilation tools, as opposed to programmers who just want their
1808 program to compile and work.
1810 @var{objfile}@dots{} are the object files to be examined. When you
1811 specify archives, @command{objdump} shows information on each of the member
1816 @c man begin OPTIONS objdump
1818 The long and short forms of options, shown here as alternatives, are
1819 equivalent. At least one option from the list
1820 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1824 @itemx --archive-header
1825 @cindex archive headers
1826 If any of the @var{objfile} files are archives, display the archive
1827 header information (in a format similar to @samp{ls -l}). Besides the
1828 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1829 the object file format of each archive member.
1831 @item --adjust-vma=@var{offset}
1832 @cindex section addresses in objdump
1833 @cindex VMA in objdump
1834 When dumping information, first add @var{offset} to all the section
1835 addresses. This is useful if the section addresses do not correspond to
1836 the symbol table, which can happen when putting sections at particular
1837 addresses when using a format which can not represent section addresses,
1840 @item -b @var{bfdname}
1841 @itemx --target=@var{bfdname}
1842 @cindex object code format
1843 Specify that the object-code format for the object files is
1844 @var{bfdname}. This option may not be necessary; @var{objdump} can
1845 automatically recognize many formats.
1849 objdump -b oasys -m vax -h fu.o
1852 displays summary information from the section headers (@option{-h}) of
1853 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1854 file in the format produced by Oasys compilers. You can list the
1855 formats available with the @option{-i} option.
1856 @xref{Target Selection}, for more information.
1859 @itemx --demangle[=@var{style}]
1860 @cindex demangling in objdump
1861 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1862 Besides removing any initial underscore prepended by the system, this
1863 makes C++ function names readable. Different compilers have different
1864 mangling styles. The optional demangling style argument can be used to
1865 choose an appropriate demangling style for your compiler. @xref{c++filt},
1866 for more information on demangling.
1870 Display debugging information. This attempts to parse STABS and IEEE
1871 debugging format information stored in the file and print it out using
1872 a C like syntax. If neither of these formats are found this option
1873 falls back on the @option{-W} option to print any DWARF information in
1877 @itemx --debugging-tags
1878 Like @option{-g}, but the information is generated in a format compatible
1882 @itemx --disassemble
1883 @cindex disassembling object code
1884 @cindex machine instructions
1885 Display the assembler mnemonics for the machine instructions from
1886 @var{objfile}. This option only disassembles those sections which are
1887 expected to contain instructions.
1890 @itemx --disassemble-all
1891 Like @option{-d}, but disassemble the contents of all sections, not just
1892 those expected to contain instructions.
1894 If the target is an ARM architecture this switch also has the effect
1895 of forcing the disassembler to decode pieces of data found in code
1896 sections as if they were instructions.
1898 @item --prefix-addresses
1899 When disassembling, print the complete address on each line. This is
1900 the older disassembly format.
1904 @itemx --endian=@{big|little@}
1906 @cindex disassembly endianness
1907 Specify the endianness of the object files. This only affects
1908 disassembly. This can be useful when disassembling a file format which
1909 does not describe endianness information, such as S-records.
1912 @itemx --file-headers
1913 @cindex object file header
1914 Display summary information from the overall header of
1915 each of the @var{objfile} files.
1918 @itemx --file-offsets
1919 @cindex object file offsets
1920 When disassembling sections, whenever a symbol is displayed, also
1921 display the file offset of the region of data that is about to be
1922 dumped. If zeroes are being skipped, then when disassembly resumes,
1923 tell the user how many zeroes were skipped and the file offset of the
1924 location from where the disassembly resumes. When dumping sections,
1925 display the file offset of the location from where the dump starts.
1927 @item --file-start-context
1928 @cindex source code context
1929 Specify that when displaying interlisted source code/disassembly
1930 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1931 context to the start of the file.
1934 @itemx --section-headers
1936 @cindex section headers
1937 Display summary information from the section headers of the
1940 File segments may be relocated to nonstandard addresses, for example by
1941 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1942 @command{ld}. However, some object file formats, such as a.out, do not
1943 store the starting address of the file segments. In those situations,
1944 although @command{ld} relocates the sections correctly, using @samp{objdump
1945 -h} to list the file section headers cannot show the correct addresses.
1946 Instead, it shows the usual addresses, which are implicit for the
1951 Print a summary of the options to @command{objdump} and exit.
1955 @cindex architectures available
1956 @cindex object formats available
1957 Display a list showing all architectures and object formats available
1958 for specification with @option{-b} or @option{-m}.
1961 @itemx --section=@var{name}
1962 @cindex section information
1963 Display information only for section @var{name}.
1966 @itemx --line-numbers
1967 @cindex source filenames for object files
1968 Label the display (using debugging information) with the filename and
1969 source line numbers corresponding to the object code or relocs shown.
1970 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1972 @item -m @var{machine}
1973 @itemx --architecture=@var{machine}
1974 @cindex architecture
1975 @cindex disassembly architecture
1976 Specify the architecture to use when disassembling object files. This
1977 can be useful when disassembling object files which do not describe
1978 architecture information, such as S-records. You can list the available
1979 architectures with the @option{-i} option.
1981 If the target is an ARM architecture then this switch has an
1982 additional effect. It restricts the disassembly to only those
1983 instructions supported by the architecture specified by @var{machine}.
1984 If it is necessary to use this switch because the input file does not
1985 contain any architecture information, but it is also desired to
1986 disassemble all the instructions use @option{-marm}.
1988 @item -M @var{options}
1989 @itemx --disassembler-options=@var{options}
1990 Pass target specific information to the disassembler. Only supported on
1991 some targets. If it is necessary to specify more than one
1992 disassembler option then multiple @option{-M} options can be used or
1993 can be placed together into a comma separated list.
1995 If the target is an ARM architecture then this switch can be used to
1996 select which register name set is used during disassembler. Specifying
1997 @option{-M reg-names-std} (the default) will select the register names as
1998 used in ARM's instruction set documentation, but with register 13 called
1999 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2000 @option{-M reg-names-apcs} will select the name set used by the ARM
2001 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2002 just use @samp{r} followed by the register number.
2004 There are also two variants on the APCS register naming scheme enabled
2005 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2006 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2007 with the normal register names or the special register names).
2009 This option can also be used for ARM architectures to force the
2010 disassembler to interpret all instructions as Thumb instructions by
2011 using the switch @option{--disassembler-options=force-thumb}. This can be
2012 useful when attempting to disassemble thumb code produced by other
2015 For the x86, some of the options duplicate functions of the @option{-m}
2016 switch, but allow finer grained control. Multiple selections from the
2017 following may be specified as a comma separated string.
2018 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
2019 the given architecture. @option{intel} and @option{att} select between
2020 intel syntax mode and AT&T syntax mode.
2021 @option{intel-mnemonic} and @option{att-mnemonic} select between
2022 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
2023 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
2024 @option{addr64}, @option{addr32},
2025 @option{addr16}, @option{data32} and @option{data16} specify the default
2026 address size and operand size. These four options will be overridden if
2027 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
2028 option string. Lastly, @option{suffix}, when in AT&T mode,
2029 instructs the disassembler to print a mnemonic suffix even when the
2030 suffix could be inferred by the operands.
2032 For PowerPC, @option{booke} controls the disassembly of BookE
2033 instructions. @option{32} and @option{64} select PowerPC and
2034 PowerPC64 disassembly, respectively. @option{e300} selects
2035 disassembly for the e300 family. @option{440} selects disassembly for
2036 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2037 single instructions of the PPC750CL.
2039 For MIPS, this option controls the printing of instruction mnemonic
2040 names and register names in disassembled instructions. Multiple
2041 selections from the following may be specified as a comma separated
2042 string, and invalid options are ignored:
2046 Print the 'raw' instruction mnemonic instead of some pseudo
2047 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2048 'sll' instead of 'nop', etc.
2050 @item gpr-names=@var{ABI}
2051 Print GPR (general-purpose register) names as appropriate
2052 for the specified ABI. By default, GPR names are selected according to
2053 the ABI of the binary being disassembled.
2055 @item fpr-names=@var{ABI}
2056 Print FPR (floating-point register) names as
2057 appropriate for the specified ABI. By default, FPR numbers are printed
2060 @item cp0-names=@var{ARCH}
2061 Print CP0 (system control coprocessor; coprocessor 0) register names
2062 as appropriate for the CPU or architecture specified by
2063 @var{ARCH}. By default, CP0 register names are selected according to
2064 the architecture and CPU of the binary being disassembled.
2066 @item hwr-names=@var{ARCH}
2067 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2068 as appropriate for the CPU or architecture specified by
2069 @var{ARCH}. By default, HWR names are selected according to
2070 the architecture and CPU of the binary being disassembled.
2072 @item reg-names=@var{ABI}
2073 Print GPR and FPR names as appropriate for the selected ABI.
2075 @item reg-names=@var{ARCH}
2076 Print CPU-specific register names (CP0 register and HWR names)
2077 as appropriate for the selected CPU or architecture.
2080 For any of the options listed above, @var{ABI} or
2081 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2082 rather than names, for the selected types of registers.
2083 You can list the available values of @var{ABI} and @var{ARCH} using
2084 the @option{--help} option.
2086 For VAX, you can specify function entry addresses with @option{-M
2087 entry:0xf00ba}. You can use this multiple times to properly
2088 disassemble VAX binary files that don't contain symbol tables (like
2089 ROM dumps). In these cases, the function entry mask would otherwise
2090 be decoded as VAX instructions, which would probably lead the rest
2091 of the function being wrongly disassembled.
2094 @itemx --private-headers
2095 Print information that is specific to the object file format. The exact
2096 information printed depends upon the object file format. For some
2097 object file formats, no additional information is printed.
2099 @item -P @var{options}
2100 @itemx --private=@var{options}
2101 Print information that is specific to the object file format. The
2102 argument @var{options} is a comma separated list that depends on the
2103 format (the lists of options is displayed with the help).
2105 For XCOFF, the available options are: @option{header}, @option{aout},
2106 @option{sections}, @option{syms}, @option{relocs}, @option{lineno},
2107 @option{loader}, @option{except}, @option{typchk}, @option{traceback}
2112 @cindex relocation entries, in object file
2113 Print the relocation entries of the file. If used with @option{-d} or
2114 @option{-D}, the relocations are printed interspersed with the
2118 @itemx --dynamic-reloc
2119 @cindex dynamic relocation entries, in object file
2120 Print the dynamic relocation entries of the file. This is only
2121 meaningful for dynamic objects, such as certain types of shared
2122 libraries. As for @option{-r}, if used with @option{-d} or
2123 @option{-D}, the relocations are printed interspersed with the
2127 @itemx --full-contents
2128 @cindex sections, full contents
2129 @cindex object file sections
2130 Display the full contents of any sections requested. By default all
2131 non-empty sections are displayed.
2135 @cindex source disassembly
2136 @cindex disassembly, with source
2137 Display source code intermixed with disassembly, if possible. Implies
2140 @item --prefix=@var{prefix}
2141 @cindex Add prefix to absolute paths
2142 Specify @var{prefix} to add to the absolute paths when used with
2145 @item --prefix-strip=@var{level}
2146 @cindex Strip absolute paths
2147 Indicate how many initial directory names to strip off the hardwired
2148 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2150 @item --show-raw-insn
2151 When disassembling instructions, print the instruction in hex as well as
2152 in symbolic form. This is the default except when
2153 @option{--prefix-addresses} is used.
2155 @item --no-show-raw-insn
2156 When disassembling instructions, do not print the instruction bytes.
2157 This is the default when @option{--prefix-addresses} is used.
2159 @item --insn-width=@var{width}
2160 @cindex Instruction width
2161 Display @var{width} bytes on a single line when disassembling
2164 @item -W[lLiaprmfFsoRt]
2165 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
2167 @cindex debug symbols
2168 Displays the contents of the debug sections in the file, if any are
2169 present. If one of the optional letters or words follows the switch
2170 then only data found in those specific sections will be dumped.
2172 Note that there is no single letter option to display the content of
2173 trace sections or .gdb_index.
2175 Note: the output from the @option{=info} option can also be affected
2176 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
2178 @item --dwarf-depth=@var{n}
2179 Limit the dump of the @code{.debug_info} section to @var{n} children.
2180 This is only useful with @option{--dwarf=info}. The default is
2181 to print all DIEs; the special value 0 for @var{n} will also have this
2184 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2185 levels will not be printed. The range for @var{n} is zero-based.
2187 @item --dwarf-start=@var{n}
2188 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2189 useful with @option{--dwarf=info}.
2191 If specified, this option will suppress printing of any header
2192 information and all DIEs before the DIE numbered @var{n}. Only
2193 siblings and children of the specified DIE will be printed.
2195 This can be used in conjunction with @option{--dwarf-depth}.
2201 @cindex debug symbols
2202 @cindex ELF object file format
2203 Display the full contents of any sections requested. Display the
2204 contents of the .stab and .stab.index and .stab.excl sections from an
2205 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2206 @code{.stab} debugging symbol-table entries are carried in an ELF
2207 section. In most other file formats, debugging symbol-table entries are
2208 interleaved with linkage symbols, and are visible in the @option{--syms}
2211 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
2212 Overview,stabs.info, The ``stabs'' debug format}.
2215 @item --start-address=@var{address}
2216 @cindex start-address
2217 Start displaying data at the specified address. This affects the output
2218 of the @option{-d}, @option{-r} and @option{-s} options.
2220 @item --stop-address=@var{address}
2221 @cindex stop-address
2222 Stop displaying data at the specified address. This affects the output
2223 of the @option{-d}, @option{-r} and @option{-s} options.
2227 @cindex symbol table entries, printing
2228 Print the symbol table entries of the file.
2229 This is similar to the information provided by the @samp{nm} program,
2230 although the display format is different. The format of the output
2231 depends upon the format of the file being dumped, but there are two main
2232 types. One looks like this:
2235 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2236 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2239 where the number inside the square brackets is the number of the entry
2240 in the symbol table, the @var{sec} number is the section number, the
2241 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2242 symbol's type, the @var{scl} number is the symbol's storage class and
2243 the @var{nx} value is the number of auxilary entries associated with
2244 the symbol. The last two fields are the symbol's value and its name.
2246 The other common output format, usually seen with ELF based files,
2250 00000000 l d .bss 00000000 .bss
2251 00000000 g .text 00000000 fred
2254 Here the first number is the symbol's value (sometimes refered to as
2255 its address). The next field is actually a set of characters and
2256 spaces indicating the flag bits that are set on the symbol. These
2257 characters are described below. Next is the section with which the
2258 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2259 not connected with any section), or @emph{*UND*} if the section is
2260 referenced in the file being dumped, but not defined there.
2262 After the section name comes another field, a number, which for common
2263 symbols is the alignment and for other symbol is the size. Finally
2264 the symbol's name is displayed.
2266 The flag characters are divided into 7 groups as follows:
2272 The symbol is a local (l), global (g), unique global (u), neither
2273 global nor local (a space) or both global and local (!). A
2274 symbol can be neither local or global for a variety of reasons, e.g.,
2275 because it is used for debugging, but it is probably an indication of
2276 a bug if it is ever both local and global. Unique global symbols are
2277 a GNU extension to the standard set of ELF symbol bindings. For such
2278 a symbol the dynamic linker will make sure that in the entire process
2279 there is just one symbol with this name and type in use.
2282 The symbol is weak (w) or strong (a space).
2285 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2288 The symbol is a warning (W) or a normal symbol (a space). A warning
2289 symbol's name is a message to be displayed if the symbol following the
2290 warning symbol is ever referenced.
2294 The symbol is an indirect reference to another symbol (I), a function
2295 to be evaluated during reloc processing (i) or a normal symbol (a
2300 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2301 normal symbol (a space).
2306 The symbol is the name of a function (F) or a file (f) or an object
2307 (O) or just a normal symbol (a space).
2311 @itemx --dynamic-syms
2312 @cindex dynamic symbol table entries, printing
2313 Print the dynamic symbol table entries of the file. This is only
2314 meaningful for dynamic objects, such as certain types of shared
2315 libraries. This is similar to the information provided by the @samp{nm}
2316 program when given the @option{-D} (@option{--dynamic}) option.
2318 @item --special-syms
2319 When displaying symbols include those which the target considers to be
2320 special in some way and which would not normally be of interest to the
2325 Print the version number of @command{objdump} and exit.
2328 @itemx --all-headers
2329 @cindex all header information, object file
2330 @cindex header information, all
2331 Display all available header information, including the symbol table and
2332 relocation entries. Using @option{-x} is equivalent to specifying all of
2333 @option{-a -f -h -p -r -t}.
2337 @cindex wide output, printing
2338 Format some lines for output devices that have more than 80 columns.
2339 Also do not truncate symbol names when they are displayed.
2342 @itemx --disassemble-zeroes
2343 Normally the disassembly output will skip blocks of zeroes. This
2344 option directs the disassembler to disassemble those blocks, just like
2351 @c man begin SEEALSO objdump
2352 nm(1), readelf(1), and the Info entries for @file{binutils}.
2360 @cindex archive contents
2361 @cindex symbol index
2363 @c man title ranlib generate index to archive.
2366 @c man begin SYNOPSIS ranlib
2367 ranlib [@option{-DhHvVt}] @var{archive}
2371 @c man begin DESCRIPTION ranlib
2373 @command{ranlib} generates an index to the contents of an archive and
2374 stores it in the archive. The index lists each symbol defined by a
2375 member of an archive that is a relocatable object file.
2377 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2379 An archive with such an index speeds up linking to the library and
2380 allows routines in the library to call each other without regard to
2381 their placement in the archive.
2383 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2384 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2389 @c man begin OPTIONS ranlib
2395 Show usage information for @command{ranlib}.
2400 Show the version number of @command{ranlib}.
2403 @cindex deterministic archives
2404 @kindex --enable-deterministic-archives
2405 Operate in @emph{deterministic} mode. The symbol map archive member's
2406 header will show zero for the UID, GID, and timestamp. When this
2407 option is used, multiple runs will produce identical output files.
2409 This is the default unless @file{binutils} was configured with
2410 @option{--enable-deterministic-archives}.
2413 Update the timestamp of the symbol map of an archive.
2416 @cindex deterministic archives
2417 @kindex --enable-deterministic-archives
2418 Do @emph{not} operate in @emph{deterministic} mode. This is the
2419 inverse of the @samp{-D} option, above: the archive index will get
2420 actual UID, GID, timestamp, and file mode values.
2422 This is the default unless @file{binutils} was configured with
2423 @option{--enable-deterministic-archives}.
2429 @c man begin SEEALSO ranlib
2430 ar(1), nm(1), and the Info entries for @file{binutils}.
2438 @cindex section sizes
2440 @c man title size list section sizes and total size.
2443 @c man begin SYNOPSIS size
2444 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2446 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2448 [@option{-t}|@option{--totals}]
2449 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2450 [@var{objfile}@dots{}]
2454 @c man begin DESCRIPTION size
2456 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2457 size---for each of the object or archive files @var{objfile} in its
2458 argument list. By default, one line of output is generated for each
2459 object file or each module in an archive.
2461 @var{objfile}@dots{} are the object files to be examined.
2462 If none are specified, the file @code{a.out} will be used.
2466 @c man begin OPTIONS size
2468 The command line options have the following meanings:
2473 @itemx --format=@var{compatibility}
2474 @cindex @command{size} display format
2475 Using one of these options, you can choose whether the output from @sc{gnu}
2476 @command{size} resembles output from System V @command{size} (using @option{-A},
2477 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2478 @option{--format=berkeley}). The default is the one-line format similar to
2480 @c Bonus for doc-source readers: you can also say --format=strange (or
2481 @c anything else that starts with 's') for sysv, and --format=boring (or
2482 @c anything else that starts with 'b') for Berkeley.
2484 Here is an example of the Berkeley (default) format of output from
2487 $ size --format=Berkeley ranlib size
2488 text data bss dec hex filename
2489 294880 81920 11592 388392 5ed28 ranlib
2490 294880 81920 11888 388688 5ee50 size
2494 This is the same data, but displayed closer to System V conventions:
2497 $ size --format=SysV ranlib size
2515 Show a summary of acceptable arguments and options.
2520 @itemx --radix=@var{number}
2521 @cindex @command{size} number format
2522 @cindex radix for section sizes
2523 Using one of these options, you can control whether the size of each
2524 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2525 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2526 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2527 values (8, 10, 16) are supported. The total size is always given in two
2528 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2529 octal and hexadecimal if you're using @option{-o}.
2532 Print total size of common symbols in each file. When using Berkeley
2533 format these are included in the bss size.
2537 Show totals of all objects listed (Berkeley format listing mode only).
2539 @item --target=@var{bfdname}
2540 @cindex object code format
2541 Specify that the object-code format for @var{objfile} is
2542 @var{bfdname}. This option may not be necessary; @command{size} can
2543 automatically recognize many formats.
2544 @xref{Target Selection}, for more information.
2548 Display the version number of @command{size}.
2554 @c man begin SEEALSO size
2555 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2562 @cindex listings strings
2563 @cindex printing strings
2564 @cindex strings, printing
2566 @c man title strings print the strings of printable characters in files.
2569 @c man begin SYNOPSIS strings
2570 strings [@option{-afovV}] [@option{-}@var{min-len}]
2571 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2572 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2573 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2574 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2575 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2576 [@option{--help}] [@option{--version}] @var{file}@dots{}
2580 @c man begin DESCRIPTION strings
2582 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2583 character sequences that are at least 4 characters long (or the number
2584 given with the options below) and are followed by an unprintable
2585 character. By default, it only prints the strings from the initialized
2586 and loaded sections of object files; for other types of files, it prints
2587 the strings from the whole file.
2589 @command{strings} is mainly useful for determining the contents of non-text
2594 @c man begin OPTIONS strings
2600 Do not scan only the initialized and loaded sections of object files;
2601 scan the whole files.
2604 @itemx --print-file-name
2605 Print the name of the file before each string.
2608 Print a summary of the program usage on the standard output and exit.
2610 @item -@var{min-len}
2611 @itemx -n @var{min-len}
2612 @itemx --bytes=@var{min-len}
2613 Print sequences of characters that are at least @var{min-len} characters
2614 long, instead of the default 4.
2617 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2618 act like @samp{-t d} instead. Since we can not be compatible with both
2619 ways, we simply chose one.
2621 @item -t @var{radix}
2622 @itemx --radix=@var{radix}
2623 Print the offset within the file before each string. The single
2624 character argument specifies the radix of the offset---@samp{o} for
2625 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2627 @item -e @var{encoding}
2628 @itemx --encoding=@var{encoding}
2629 Select the character encoding of the strings that are to be found.
2630 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2631 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2632 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2633 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2634 littleendian. Useful for finding wide character strings. (@samp{l}
2635 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2637 @item -T @var{bfdname}
2638 @itemx --target=@var{bfdname}
2639 @cindex object code format
2640 Specify an object code format other than your system's default format.
2641 @xref{Target Selection}, for more information.
2646 Print the program version number on the standard output and exit.
2652 @c man begin SEEALSO strings
2653 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2654 and the Info entries for @file{binutils}.
2662 @cindex removing symbols
2663 @cindex discarding symbols
2664 @cindex symbols, discarding
2666 @c man title strip Discard symbols from object files.
2669 @c man begin SYNOPSIS strip
2670 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2671 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2672 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2673 [@option{-s}|@option{--strip-all}]
2674 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2675 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2676 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2677 [@option{-w}|@option{--wildcard}]
2678 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2679 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2680 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2681 [@option{--keep-file-symbols}]
2682 [@option{--only-keep-debug}]
2683 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2684 [@option{--help}] [@option{--info}]
2685 @var{objfile}@dots{}
2689 @c man begin DESCRIPTION strip
2691 @sc{gnu} @command{strip} discards all symbols from object files
2692 @var{objfile}. The list of object files may include archives.
2693 At least one object file must be given.
2695 @command{strip} modifies the files named in its argument,
2696 rather than writing modified copies under different names.
2700 @c man begin OPTIONS strip
2703 @item -F @var{bfdname}
2704 @itemx --target=@var{bfdname}
2705 Treat the original @var{objfile} as a file with the object
2706 code format @var{bfdname}, and rewrite it in the same format.
2707 @xref{Target Selection}, for more information.
2710 Show a summary of the options to @command{strip} and exit.
2713 Display a list showing all architectures and object formats available.
2715 @item -I @var{bfdname}
2716 @itemx --input-target=@var{bfdname}
2717 Treat the original @var{objfile} as a file with the object
2718 code format @var{bfdname}.
2719 @xref{Target Selection}, for more information.
2721 @item -O @var{bfdname}
2722 @itemx --output-target=@var{bfdname}
2723 Replace @var{objfile} with a file in the output format @var{bfdname}.
2724 @xref{Target Selection}, for more information.
2726 @item -R @var{sectionname}
2727 @itemx --remove-section=@var{sectionname}
2728 Remove any section named @var{sectionname} from the output file. This
2729 option may be given more than once. Note that using this option
2730 inappropriately may make the output file unusable.
2739 @itemx --strip-debug
2740 Remove debugging symbols only.
2742 @item --strip-unneeded
2743 Remove all symbols that are not needed for relocation processing.
2745 @item -K @var{symbolname}
2746 @itemx --keep-symbol=@var{symbolname}
2747 When stripping symbols, keep symbol @var{symbolname} even if it would
2748 normally be stripped. This option may be given more than once.
2750 @item -N @var{symbolname}
2751 @itemx --strip-symbol=@var{symbolname}
2752 Remove symbol @var{symbolname} from the source file. This option may be
2753 given more than once, and may be combined with strip options other than
2757 Put the stripped output in @var{file}, rather than replacing the
2758 existing file. When this argument is used, only one @var{objfile}
2759 argument may be specified.
2762 @itemx --preserve-dates
2763 Preserve the access and modification dates of the file.
2767 Permit regular expressions in @var{symbolname}s used in other command
2768 line options. The question mark (?), asterisk (*), backslash (\) and
2769 square brackets ([]) operators can be used anywhere in the symbol
2770 name. If the first character of the symbol name is the exclamation
2771 point (!) then the sense of the switch is reversed for that symbol.
2778 would cause strip to only keep symbols that start with the letters
2779 ``fo'', but to discard the symbol ``foo''.
2782 @itemx --discard-all
2783 Remove non-global symbols.
2786 @itemx --discard-locals
2787 Remove compiler-generated local symbols.
2788 (These usually start with @samp{L} or @samp{.}.)
2790 @item --keep-file-symbols
2791 When stripping a file, perhaps with @option{--strip-debug} or
2792 @option{--strip-unneeded}, retain any symbols specifying source file names,
2793 which would otherwise get stripped.
2795 @item --only-keep-debug
2796 Strip a file, removing contents of any sections that would not be
2797 stripped by @option{--strip-debug} and leaving the debugging sections
2798 intact. In ELF files, this preserves all note sections in the output.
2800 The intention is that this option will be used in conjunction with
2801 @option{--add-gnu-debuglink} to create a two part executable. One a
2802 stripped binary which will occupy less space in RAM and in a
2803 distribution and the second a debugging information file which is only
2804 needed if debugging abilities are required. The suggested procedure
2805 to create these files is as follows:
2808 @item Link the executable as normal. Assuming that is is called
2810 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2811 create a file containing the debugging info.
2812 @item Run @code{objcopy --strip-debug foo} to create a
2813 stripped executable.
2814 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2815 to add a link to the debugging info into the stripped executable.
2818 Note---the choice of @code{.dbg} as an extension for the debug info
2819 file is arbitrary. Also the @code{--only-keep-debug} step is
2820 optional. You could instead do this:
2823 @item Link the executable as normal.
2824 @item Copy @code{foo} to @code{foo.full}
2825 @item Run @code{strip --strip-debug foo}
2826 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2829 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2830 full executable. It does not have to be a file created by the
2831 @option{--only-keep-debug} switch.
2833 Note---this switch is only intended for use on fully linked files. It
2834 does not make sense to use it on object files where the debugging
2835 information may be incomplete. Besides the gnu_debuglink feature
2836 currently only supports the presence of one filename containing
2837 debugging information, not multiple filenames on a one-per-object-file
2842 Show the version number for @command{strip}.
2846 Verbose output: list all object files modified. In the case of
2847 archives, @samp{strip -v} lists all members of the archive.
2853 @c man begin SEEALSO strip
2854 the Info entries for @file{binutils}.
2858 @node c++filt, addr2line, elfedit, Top
2862 @cindex demangling C++ symbols
2864 @c man title cxxfilt Demangle C++ and Java symbols.
2867 @c man begin SYNOPSIS cxxfilt
2868 c++filt [@option{-_}|@option{--strip-underscores}]
2869 [@option{-n}|@option{--no-strip-underscores}]
2870 [@option{-p}|@option{--no-params}]
2871 [@option{-t}|@option{--types}]
2872 [@option{-i}|@option{--no-verbose}]
2873 [@option{-s} @var{format}|@option{--format=}@var{format}]
2874 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2878 @c man begin DESCRIPTION cxxfilt
2881 The C++ and Java languages provide function overloading, which means
2882 that you can write many functions with the same name, providing that
2883 each function takes parameters of different types. In order to be
2884 able to distinguish these similarly named functions C++ and Java
2885 encode them into a low-level assembler name which uniquely identifies
2886 each different version. This process is known as @dfn{mangling}. The
2888 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2889 MS-DOS this program is named @command{CXXFILT}.}
2890 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2891 names into user-level names so that they can be read.
2893 Every alphanumeric word (consisting of letters, digits, underscores,
2894 dollars, or periods) seen in the input is a potential mangled name.
2895 If the name decodes into a C++ name, the C++ name replaces the
2896 low-level name in the output, otherwise the original word is output.
2897 In this way you can pass an entire assembler source file, containing
2898 mangled names, through @command{c++filt} and see the same source file
2899 containing demangled names.
2901 You can also use @command{c++filt} to decipher individual symbols by
2902 passing them on the command line:
2905 c++filt @var{symbol}
2908 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2909 names from the standard input instead. All the results are printed on
2910 the standard output. The difference between reading names from the
2911 command line versus reading names from the standard input is that
2912 command line arguments are expected to be just mangled names and no
2913 checking is performed to separate them from surrounding text. Thus
2920 will work and demangle the name to ``f()'' whereas:
2926 will not work. (Note the extra comma at the end of the mangled
2927 name which makes it invalid). This command however will work:
2930 echo _Z1fv, | c++filt -n
2933 and will display ``f(),'', i.e., the demangled name followed by a
2934 trailing comma. This behaviour is because when the names are read
2935 from the standard input it is expected that they might be part of an
2936 assembler source file where there might be extra, extraneous
2937 characters trailing after a mangled name. For example:
2940 .type _Z1fv, @@function
2945 @c man begin OPTIONS cxxfilt
2949 @itemx --strip-underscores
2950 On some systems, both the C and C++ compilers put an underscore in front
2951 of every name. For example, the C name @code{foo} gets the low-level
2952 name @code{_foo}. This option removes the initial underscore. Whether
2953 @command{c++filt} removes the underscore by default is target dependent.
2956 @itemx --no-strip-underscores
2957 Do not remove the initial underscore.
2961 When demangling the name of a function, do not display the types of
2962 the function's parameters.
2966 Attempt to demangle types as well as function names. This is disabled
2967 by default since mangled types are normally only used internally in
2968 the compiler, and they can be confused with non-mangled names. For example,
2969 a function called ``a'' treated as a mangled type name would be
2970 demangled to ``signed char''.
2974 Do not include implementation details (if any) in the demangled
2977 @item -s @var{format}
2978 @itemx --format=@var{format}
2979 @command{c++filt} can decode various methods of mangling, used by
2980 different compilers. The argument to this option selects which
2985 Automatic selection based on executable (the default method)
2987 the one used by the @sc{gnu} C++ compiler (g++)
2989 the one used by the Lucid compiler (lcc)
2991 the one specified by the C++ Annotated Reference Manual
2993 the one used by the HP compiler (aCC)
2995 the one used by the EDG compiler
2997 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2999 the one used by the @sc{gnu} Java compiler (gcj)
3001 the one used by the @sc{gnu} Ada compiler (GNAT).
3005 Print a summary of the options to @command{c++filt} and exit.
3008 Print the version number of @command{c++filt} and exit.
3014 @c man begin SEEALSO cxxfilt
3015 the Info entries for @file{binutils}.
3020 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3021 user interface are subject to change in future releases. In particular,
3022 a command-line option may be required in the future to decode a name
3023 passed as an argument on the command line; in other words,
3026 c++filt @var{symbol}
3030 may in a future release become
3033 c++filt @var{option} @var{symbol}
3041 @cindex address to file name and line number
3043 @c man title addr2line convert addresses into file names and line numbers.
3046 @c man begin SYNOPSIS addr2line
3047 addr2line [@option{-a}|@option{--addresses}]
3048 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3049 [@option{-C}|@option{--demangle}[=@var{style}]]
3050 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3051 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3052 [@option{-i}|@option{--inlines}]
3053 [@option{-p}|@option{--pretty-print}]
3054 [@option{-j}|@option{--section=}@var{name}]
3055 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3060 @c man begin DESCRIPTION addr2line
3062 @command{addr2line} translates addresses into file names and line numbers.
3063 Given an address in an executable or an offset in a section of a relocatable
3064 object, it uses the debugging information to figure out which file name and
3065 line number are associated with it.
3067 The executable or relocatable object to use is specified with the @option{-e}
3068 option. The default is the file @file{a.out}. The section in the relocatable
3069 object to use is specified with the @option{-j} option.
3071 @command{addr2line} has two modes of operation.
3073 In the first, hexadecimal addresses are specified on the command line,
3074 and @command{addr2line} displays the file name and line number for each
3077 In the second, @command{addr2line} reads hexadecimal addresses from
3078 standard input, and prints the file name and line number for each
3079 address on standard output. In this mode, @command{addr2line} may be used
3080 in a pipe to convert dynamically chosen addresses.
3082 The format of the output is @samp{FILENAME:LINENO}. The file name and
3083 line number for each input address is printed on separate lines.
3085 If the @option{-f} option is used, then each @samp{FILENAME:LINENO}
3086 line is preceded by @samp{FUNCTIONNAME} which is the name of the
3087 function containing the address.
3089 If the @option{-i} option is used and the code at the given address is
3090 present there because of inlining by the compiler then the
3091 @samp{@{FUNCTIONNAME@} FILENAME:LINENO} information for the inlining
3092 function will be displayed afterwards. This continues recursively
3093 until there is no more inlining to report.
3095 If the @option{-a} option is used then the output is prefixed by the
3098 If the @option{-p} option is used then the output for each input
3099 address is displayed on one, possibly quite long, line. If
3100 @option{-p} is not used then the output is broken up into multiple
3101 lines, based on the paragraphs above.
3103 If the file name or function name can not be determined,
3104 @command{addr2line} will print two question marks in their place. If the
3105 line number can not be determined, @command{addr2line} will print 0.
3109 @c man begin OPTIONS addr2line
3111 The long and short forms of options, shown here as alternatives, are
3117 Display the address before the function name, file and line number
3118 information. The address is printed with a @samp{0x} prefix to easily
3121 @item -b @var{bfdname}
3122 @itemx --target=@var{bfdname}
3123 @cindex object code format
3124 Specify that the object-code format for the object files is
3128 @itemx --demangle[=@var{style}]
3129 @cindex demangling in objdump
3130 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3131 Besides removing any initial underscore prepended by the system, this
3132 makes C++ function names readable. Different compilers have different
3133 mangling styles. The optional demangling style argument can be used to
3134 choose an appropriate demangling style for your compiler. @xref{c++filt},
3135 for more information on demangling.
3137 @item -e @var{filename}
3138 @itemx --exe=@var{filename}
3139 Specify the name of the executable for which addresses should be
3140 translated. The default file is @file{a.out}.
3144 Display function names as well as file and line number information.
3148 Display only the base of each file name.
3152 If the address belongs to a function that was inlined, the source
3153 information for all enclosing scopes back to the first non-inlined
3154 function will also be printed. For example, if @code{main} inlines
3155 @code{callee1} which inlines @code{callee2}, and address is from
3156 @code{callee2}, the source information for @code{callee1} and @code{main}
3157 will also be printed.
3161 Read offsets relative to the specified section instead of absolute addresses.
3164 @itemx --pretty-print
3165 Make the output more human friendly: each location are printed on one line.
3166 If option @option{-i} is specified, lines for all enclosing scopes are
3167 prefixed with @samp{(inlined by)}.
3173 @c man begin SEEALSO addr2line
3174 Info entries for @file{binutils}.
3181 @command{nlmconv} converts a relocatable object file into a NetWare
3185 @command{nlmconv} currently works with @samp{i386} object
3186 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3187 object files in @sc{elf}, or @code{a.out} format@footnote{
3188 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3189 format in the Binary File Descriptor library. It has only been tested
3190 with the above formats.}.
3194 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3195 utilities, since it is only useful for NLM targets.
3198 @c man title nlmconv converts object code into an NLM.
3201 @c man begin SYNOPSIS nlmconv
3202 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3203 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3204 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3205 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3206 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3207 @var{infile} @var{outfile}
3211 @c man begin DESCRIPTION nlmconv
3213 @command{nlmconv} converts the relocatable @samp{i386} object file
3214 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3215 reading @var{headerfile} for NLM header information. For instructions
3216 on writing the NLM command file language used in header files, see the
3217 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3218 Development and Tools Overview}, which is part of the NLM Software
3219 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3220 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3223 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3226 @command{nlmconv} can perform a link step. In other words, you can list
3227 more than one object file for input if you list them in the definitions
3228 file (rather than simply specifying one input file on the command line).
3229 In this case, @command{nlmconv} calls the linker for you.
3233 @c man begin OPTIONS nlmconv
3236 @item -I @var{bfdname}
3237 @itemx --input-target=@var{bfdname}
3238 Object format of the input file. @command{nlmconv} can usually determine
3239 the format of a given file (so no default is necessary).
3240 @xref{Target Selection}, for more information.
3242 @item -O @var{bfdname}
3243 @itemx --output-target=@var{bfdname}
3244 Object format of the output file. @command{nlmconv} infers the output
3245 format based on the input format, e.g. for a @samp{i386} input file the
3246 output format is @samp{nlm32-i386}.
3247 @xref{Target Selection}, for more information.
3249 @item -T @var{headerfile}
3250 @itemx --header-file=@var{headerfile}
3251 Reads @var{headerfile} for NLM header information. For instructions on
3252 writing the NLM command file language used in header files, see@ see the
3253 @samp{linkers} section, of the @cite{NLM Development and Tools
3254 Overview}, which is part of the NLM Software Developer's Kit, available
3259 Displays (on standard error) the linker command line used by @command{nlmconv}.
3261 @item -l @var{linker}
3262 @itemx --linker=@var{linker}
3263 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3268 Prints a usage summary.
3272 Prints the version number for @command{nlmconv}.
3278 @c man begin SEEALSO nlmconv
3279 the Info entries for @file{binutils}.
3286 @command{windmc} may be used to generator Windows message resources.
3289 @emph{Warning:} @command{windmc} is not always built as part of the binary
3290 utilities, since it is only useful for Windows targets.
3293 @c man title windmc generates Windows message resources.
3296 @c man begin SYNOPSIS windmc
3297 windmc [options] input-file
3301 @c man begin DESCRIPTION windmc
3303 @command{windmc} reads message definitions from an input file (.mc) and
3304 translate them into a set of output files. The output files may be of
3309 A C header file containing the message definitions.
3312 A resource file compilable by the @command{windres} tool.
3315 One or more binary files containing the resource data for a specific
3319 A C include file that maps message id's to their symbolic name.
3322 The exact description of these different formats is available in
3323 documentation from Microsoft.
3325 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3326 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3327 Windows Message Compiler.
3331 @c man begin OPTIONS windmc
3336 Specifies that the input file specified is ASCII. This is the default
3341 Specifies that messages in the output @code{bin} files should be in ASCII
3346 Specifies that @code{bin} filenames should have to be prefixed by the
3347 basename of the source file.
3351 Sets the customer bit in all message id's.
3353 @item -C @var{codepage}
3354 @itemx --codepage_in @var{codepage}
3355 Sets the default codepage to be used to convert input file to UTF16. The
3356 default is ocdepage 1252.
3359 @itemx --decimal_values
3360 Outputs the constants in the header file in decimal. Default is using
3364 @itemx --extension @var{ext}
3365 The extension for the header file. The default is .h extension.
3367 @item -F @var{target}
3368 @itemx --target @var{target}
3369 Specify the BFD format to use for a bin file as output. This
3370 is a BFD target name; you can use the @option{--help} option to see a list
3371 of supported targets. Normally @command{windmc} will use the default
3372 format, which is the first one listed by the @option{--help} option.
3374 @ref{Target Selection}.
3378 @itemx --headerdir @var{path}
3379 The target directory of the generated header file. The default is the
3384 Displays a list of command line options and then exits.
3386 @item -m @var{characters}
3387 @itemx --maxlength @var{characters}
3388 Instructs @command{windmc} to generate a warning if the length
3389 of any message exceeds the number specified.
3392 @itemx --nullterminate
3393 Terminate message text in @code{bin} files by zero. By default they are
3394 terminated by CR/LF.
3397 @itemx --hresult_use
3398 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3399 file, using HRESULT definitions. Status codes are used if the flag is not
3402 @item -O @var{codepage}
3403 @itemx --codepage_out @var{codepage}
3404 Sets the default codepage to be used to output text files. The default
3408 @itemx --rcdir @var{path}
3409 The target directory for the generated @code{rc} script and the generated
3410 @code{bin} files that the resource compiler script includes. The default
3411 is the current directory.
3415 Specifies that the input file is UTF16.
3418 @itemx --unicode_out
3419 Specifies that messages in the output @code{bin} file should be in UTF16
3420 format. This is the default behaviour.
3424 Enable verbose mode.
3428 Prints the version number for @command{windmc}.
3431 @itemx --xdgb @var{path}
3432 The path of the @code{dbg} C include file that maps message id's to the
3433 symbolic name. No such file is generated without specifying the switch.
3439 @c man begin SEEALSO windmc
3440 the Info entries for @file{binutils}.
3447 @command{windres} may be used to manipulate Windows resources.
3450 @emph{Warning:} @command{windres} is not always built as part of the binary
3451 utilities, since it is only useful for Windows targets.
3454 @c man title windres manipulate Windows resources.
3457 @c man begin SYNOPSIS windres
3458 windres [options] [input-file] [output-file]
3462 @c man begin DESCRIPTION windres
3464 @command{windres} reads resources from an input file and copies them into
3465 an output file. Either file may be in one of three formats:
3469 A text format read by the Resource Compiler.
3472 A binary format generated by the Resource Compiler.
3475 A COFF object or executable.
3478 The exact description of these different formats is available in
3479 documentation from Microsoft.
3481 When @command{windres} converts from the @code{rc} format to the @code{res}
3482 format, it is acting like the Windows Resource Compiler. When
3483 @command{windres} converts from the @code{res} format to the @code{coff}
3484 format, it is acting like the Windows @code{CVTRES} program.
3486 When @command{windres} generates an @code{rc} file, the output is similar
3487 but not identical to the format expected for the input. When an input
3488 @code{rc} file refers to an external filename, an output @code{rc} file
3489 will instead include the file contents.
3491 If the input or output format is not specified, @command{windres} will
3492 guess based on the file name, or, for the input file, the file contents.
3493 A file with an extension of @file{.rc} will be treated as an @code{rc}
3494 file, a file with an extension of @file{.res} will be treated as a
3495 @code{res} file, and a file with an extension of @file{.o} or
3496 @file{.exe} will be treated as a @code{coff} file.
3498 If no output file is specified, @command{windres} will print the resources
3499 in @code{rc} format to standard output.
3501 The normal use is for you to write an @code{rc} file, use @command{windres}
3502 to convert it to a COFF object file, and then link the COFF file into
3503 your application. This will make the resources described in the
3504 @code{rc} file available to Windows.
3508 @c man begin OPTIONS windres
3511 @item -i @var{filename}
3512 @itemx --input @var{filename}
3513 The name of the input file. If this option is not used, then
3514 @command{windres} will use the first non-option argument as the input file
3515 name. If there are no non-option arguments, then @command{windres} will
3516 read from standard input. @command{windres} can not read a COFF file from
3519 @item -o @var{filename}
3520 @itemx --output @var{filename}
3521 The name of the output file. If this option is not used, then
3522 @command{windres} will use the first non-option argument, after any used
3523 for the input file name, as the output file name. If there is no
3524 non-option argument, then @command{windres} will write to standard output.
3525 @command{windres} can not write a COFF file to standard output. Note,
3526 for compatibility with @command{rc} the option @option{-fo} is also
3527 accepted, but its use is not recommended.
3529 @item -J @var{format}
3530 @itemx --input-format @var{format}
3531 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3532 @samp{coff}. If no input format is specified, @command{windres} will
3533 guess, as described above.
3535 @item -O @var{format}
3536 @itemx --output-format @var{format}
3537 The output format to generate. @var{format} may be @samp{res},
3538 @samp{rc}, or @samp{coff}. If no output format is specified,
3539 @command{windres} will guess, as described above.
3541 @item -F @var{target}
3542 @itemx --target @var{target}
3543 Specify the BFD format to use for a COFF file as input or output. This
3544 is a BFD target name; you can use the @option{--help} option to see a list
3545 of supported targets. Normally @command{windres} will use the default
3546 format, which is the first one listed by the @option{--help} option.
3548 @ref{Target Selection}.
3551 @item --preprocessor @var{program}
3552 When @command{windres} reads an @code{rc} file, it runs it through the C
3553 preprocessor first. This option may be used to specify the preprocessor
3554 to use, including any leading arguments. The default preprocessor
3555 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3557 @item --preprocessor-arg @var{option}
3558 When @command{windres} reads an @code{rc} file, it runs it through
3559 the C preprocessor first. This option may be used to specify additional
3560 text to be passed to preprocessor on its command line.
3561 This option can be used multiple times to add multiple options to the
3562 preprocessor command line.
3564 @item -I @var{directory}
3565 @itemx --include-dir @var{directory}
3566 Specify an include directory to use when reading an @code{rc} file.
3567 @command{windres} will pass this to the preprocessor as an @option{-I}
3568 option. @command{windres} will also search this directory when looking for
3569 files named in the @code{rc} file. If the argument passed to this command
3570 matches any of the supported @var{formats} (as described in the @option{-J}
3571 option), it will issue a deprecation warning, and behave just like the
3572 @option{-J} option. New programs should not use this behaviour. If a
3573 directory happens to match a @var{format}, simple prefix it with @samp{./}
3574 to disable the backward compatibility.
3576 @item -D @var{target}
3577 @itemx --define @var{sym}[=@var{val}]
3578 Specify a @option{-D} option to pass to the preprocessor when reading an
3581 @item -U @var{target}
3582 @itemx --undefine @var{sym}
3583 Specify a @option{-U} option to pass to the preprocessor when reading an
3587 Ignored for compatibility with rc.
3590 Enable verbose mode. This tells you what the preprocessor is if you
3594 @item --codepage @var{val}
3595 Specify the default codepage to use when reading an @code{rc} file.
3596 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3597 codepage code. The valid range is from zero up to 0xffff, but the
3598 validity of the codepage is host and configuration dependent.
3601 @item --language @var{val}
3602 Specify the default language to use when reading an @code{rc} file.
3603 @var{val} should be a hexadecimal language code. The low eight bits are
3604 the language, and the high eight bits are the sublanguage.
3606 @item --use-temp-file
3607 Use a temporary file to instead of using popen to read the output of
3608 the preprocessor. Use this option if the popen implementation is buggy
3609 on the host (eg., certain non-English language versions of Windows 95 and
3610 Windows 98 are known to have buggy popen where the output will instead
3613 @item --no-use-temp-file
3614 Use popen, not a temporary file, to read the output of the preprocessor.
3615 This is the default behaviour.
3619 Prints a usage summary.
3623 Prints the version number for @command{windres}.
3626 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3627 this will turn on parser debugging.
3633 @c man begin SEEALSO windres
3634 the Info entries for @file{binutils}.
3643 @command{dlltool} is used to create the files needed to create dynamic
3644 link libraries (DLLs) on systems which understand PE format image
3645 files such as Windows. A DLL contains an export table which contains
3646 information that the runtime loader needs to resolve references from a
3647 referencing program.
3649 The export table is generated by this program by reading in a
3650 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3651 will be in the DLL. A @file{.o} file can contain information in
3652 special @samp{.drectve} sections with export information.
3655 @emph{Note:} @command{dlltool} is not always built as part of the
3656 binary utilities, since it is only useful for those targets which
3660 @c man title dlltool Create files needed to build and use DLLs.
3663 @c man begin SYNOPSIS dlltool
3664 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3665 [@option{-b}|@option{--base-file} @var{base-file-name}]
3666 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3667 [@option{-z}|@option{--output-def} @var{def-file-name}]
3668 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3669 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3670 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3671 [@option{--exclude-symbols} @var{list}]
3672 [@option{--no-default-excludes}]
3673 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3674 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3675 [@option{-a}|@option{--add-indirect}]
3676 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3677 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3678 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3679 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3680 [@option{--use-nul-prefixed-import-tables}]
3681 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3682 [@option{-i}|@option{--interwork}]
3683 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3684 [@option{-v}|@option{--verbose}]
3685 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3686 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
3687 [object-file @dots{}]
3691 @c man begin DESCRIPTION dlltool
3693 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3694 @option{-b} options as well as object files specified on the command
3695 line. It then processes these inputs and if the @option{-e} option has
3696 been specified it creates a exports file. If the @option{-l} option
3697 has been specified it creates a library file and if the @option{-z} option
3698 has been specified it creates a def file. Any or all of the @option{-e},
3699 @option{-l} and @option{-z} options can be present in one invocation of
3702 When creating a DLL, along with the source for the DLL, it is necessary
3703 to have three other files. @command{dlltool} can help with the creation of
3706 The first file is a @file{.def} file which specifies which functions are
3707 exported from the DLL, which functions the DLL imports, and so on. This
3708 is a text file and can be created by hand, or @command{dlltool} can be used
3709 to create it using the @option{-z} option. In this case @command{dlltool}
3710 will scan the object files specified on its command line looking for
3711 those functions which have been specially marked as being exported and
3712 put entries for them in the @file{.def} file it creates.
3714 In order to mark a function as being exported from a DLL, it needs to
3715 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3716 section of the object file. This can be done in C by using the
3720 asm (".section .drectve");
3721 asm (".ascii \"-export:my_func\"");
3723 int my_func (void) @{ @dots{} @}
3726 The second file needed for DLL creation is an exports file. This file
3727 is linked with the object files that make up the body of the DLL and it
3728 handles the interface between the DLL and the outside world. This is a
3729 binary file and it can be created by giving the @option{-e} option to
3730 @command{dlltool} when it is creating or reading in a @file{.def} file.
3732 The third file needed for DLL creation is the library file that programs
3733 will link with in order to access the functions in the DLL (an `import
3734 library'). This file can be created by giving the @option{-l} option to
3735 dlltool when it is creating or reading in a @file{.def} file.
3737 If the @option{-y} option is specified, dlltool generates a delay-import
3738 library that can be used instead of the normal import library to allow
3739 a program to link to the dll only as soon as an imported function is
3740 called for the first time. The resulting executable will need to be
3741 linked to the static delayimp library containing __delayLoadHelper2(),
3742 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
3744 @command{dlltool} builds the library file by hand, but it builds the
3745 exports file by creating temporary files containing assembler statements
3746 and then assembling these. The @option{-S} command line option can be
3747 used to specify the path to the assembler that dlltool will use,
3748 and the @option{-f} option can be used to pass specific flags to that
3749 assembler. The @option{-n} can be used to prevent dlltool from deleting
3750 these temporary assembler files when it is done, and if @option{-n} is
3751 specified twice then this will prevent dlltool from deleting the
3752 temporary object files it used to build the library.
3754 Here is an example of creating a DLL from a source file @samp{dll.c} and
3755 also creating a program (from an object file called @samp{program.o})
3760 dlltool -e exports.o -l dll.lib dll.o
3761 gcc dll.o exports.o -o dll.dll
3762 gcc program.o dll.lib -o program
3766 @command{dlltool} may also be used to query an existing import library
3767 to determine the name of the DLL to which it is associated. See the
3768 description of the @option{-I} or @option{--identify} option.
3772 @c man begin OPTIONS dlltool
3774 The command line options have the following meanings:
3778 @item -d @var{filename}
3779 @itemx --input-def @var{filename}
3780 @cindex input .def file
3781 Specifies the name of a @file{.def} file to be read in and processed.
3783 @item -b @var{filename}
3784 @itemx --base-file @var{filename}
3786 Specifies the name of a base file to be read in and processed. The
3787 contents of this file will be added to the relocation section in the
3788 exports file generated by dlltool.
3790 @item -e @var{filename}
3791 @itemx --output-exp @var{filename}
3792 Specifies the name of the export file to be created by dlltool.
3794 @item -z @var{filename}
3795 @itemx --output-def @var{filename}
3796 Specifies the name of the @file{.def} file to be created by dlltool.
3798 @item -l @var{filename}
3799 @itemx --output-lib @var{filename}
3800 Specifies the name of the library file to be created by dlltool.
3802 @item -y @var{filename}
3803 @itemx --output-delaylib @var{filename}
3804 Specifies the name of the delay-import library file to be created by dlltool.
3806 @item --export-all-symbols
3807 Treat all global and weak defined symbols found in the input object
3808 files as symbols to be exported. There is a small list of symbols which
3809 are not exported by default; see the @option{--no-default-excludes}
3810 option. You may add to the list of symbols to not export by using the
3811 @option{--exclude-symbols} option.
3813 @item --no-export-all-symbols
3814 Only export symbols explicitly listed in an input @file{.def} file or in
3815 @samp{.drectve} sections in the input object files. This is the default
3816 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3817 attributes in the source code.
3819 @item --exclude-symbols @var{list}
3820 Do not export the symbols in @var{list}. This is a list of symbol names
3821 separated by comma or colon characters. The symbol names should not
3822 contain a leading underscore. This is only meaningful when
3823 @option{--export-all-symbols} is used.
3825 @item --no-default-excludes
3826 When @option{--export-all-symbols} is used, it will by default avoid
3827 exporting certain special symbols. The current list of symbols to avoid
3828 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3829 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3830 to go ahead and export these special symbols. This is only meaningful
3831 when @option{--export-all-symbols} is used.
3834 @itemx --as @var{path}
3835 Specifies the path, including the filename, of the assembler to be used
3836 to create the exports file.
3838 @item -f @var{options}
3839 @itemx --as-flags @var{options}
3840 Specifies any specific command line options to be passed to the
3841 assembler when building the exports file. This option will work even if
3842 the @option{-S} option is not used. This option only takes one argument,
3843 and if it occurs more than once on the command line, then later
3844 occurrences will override earlier occurrences. So if it is necessary to
3845 pass multiple options to the assembler they should be enclosed in
3849 @itemx --dll-name @var{name}
3850 Specifies the name to be stored in the @file{.def} file as the name of
3851 the DLL when the @option{-e} option is used. If this option is not
3852 present, then the filename given to the @option{-e} option will be
3853 used as the name of the DLL.
3855 @item -m @var{machine}
3856 @itemx -machine @var{machine}
3857 Specifies the type of machine for which the library file should be
3858 built. @command{dlltool} has a built in default type, depending upon how
3859 it was created, but this option can be used to override that. This is
3860 normally only useful when creating DLLs for an ARM processor, when the
3861 contents of the DLL are actually encode using Thumb instructions.
3864 @itemx --add-indirect
3865 Specifies that when @command{dlltool} is creating the exports file it
3866 should add a section which allows the exported functions to be
3867 referenced without using the import library. Whatever the hell that
3871 @itemx --add-underscore
3872 Specifies that when @command{dlltool} is creating the exports file it
3873 should prepend an underscore to the names of @emph{all} exported symbols.
3875 @item --no-leading-underscore
3876 @item --leading-underscore
3877 Specifies whether standard symbol should be forced to be prefixed, or
3880 @item --add-stdcall-underscore
3881 Specifies that when @command{dlltool} is creating the exports file it
3882 should prepend an underscore to the names of exported @emph{stdcall}
3883 functions. Variable names and non-stdcall function names are not modified.
3884 This option is useful when creating GNU-compatible import libs for third
3885 party DLLs that were built with MS-Windows tools.
3889 Specifies that when @command{dlltool} is creating the exports file it
3890 should not append the string @samp{@@ <number>}. These numbers are
3891 called ordinal numbers and they represent another way of accessing the
3892 function in a DLL, other than by name.
3895 @itemx --add-stdcall-alias
3896 Specifies that when @command{dlltool} is creating the exports file it
3897 should add aliases for stdcall symbols without @samp{@@ <number>}
3898 in addition to the symbols with @samp{@@ <number>}.
3901 @itemx --ext-prefix-alias @var{prefix}
3902 Causes @command{dlltool} to create external aliases for all DLL
3903 imports with the specified prefix. The aliases are created for both
3904 external and import symbols with no leading underscore.
3908 Specifies that when @command{dlltool} is creating the exports and library
3909 files it should omit the @code{.idata4} section. This is for compatibility
3910 with certain operating systems.
3912 @item --use-nul-prefixed-import-tables
3913 Specifies that when @command{dlltool} is creating the exports and library
3914 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
3915 element. This emulates old gnu import library generation of
3916 @code{dlltool}. By default this option is turned off.
3920 Specifies that when @command{dlltool} is creating the exports and library
3921 files it should omit the @code{.idata5} section. This is for compatibility
3922 with certain operating systems.
3924 @item -I @var{filename}
3925 @itemx --identify @var{filename}
3926 Specifies that @command{dlltool} should inspect the import library
3927 indicated by @var{filename} and report, on @code{stdout}, the name(s)
3928 of the associated DLL(s). This can be performed in addition to any
3929 other operations indicated by the other options and arguments.
3930 @command{dlltool} fails if the import library does not exist or is not
3931 actually an import library. See also @option{--identify-strict}.
3933 @item --identify-strict
3934 Modifies the behavior of the @option{--identify} option, such
3935 that an error is reported if @var{filename} is associated with
3940 Specifies that @command{dlltool} should mark the objects in the library
3941 file and exports file that it produces as supporting interworking
3942 between ARM and Thumb code.
3946 Makes @command{dlltool} preserve the temporary assembler files it used to
3947 create the exports file. If this option is repeated then dlltool will
3948 also preserve the temporary object files it uses to create the library
3951 @item -t @var{prefix}
3952 @itemx --temp-prefix @var{prefix}
3953 Makes @command{dlltool} use @var{prefix} when constructing the names of
3954 temporary assembler and object files. By default, the temp file prefix
3955 is generated from the pid.
3959 Make dlltool describe what it is doing.
3963 Displays a list of command line options and then exits.
3967 Displays dlltool's version number and then exits.
3974 * def file format:: The format of the dlltool @file{.def} file
3977 @node def file format
3978 @section The format of the @command{dlltool} @file{.def} file
3980 A @file{.def} file contains any number of the following commands:
3984 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3985 The result is going to be named @var{name}@code{.exe}.
3987 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3988 The result is going to be named @var{name}@code{.dll}.
3990 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
3991 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3992 Declares @var{name1} as an exported symbol from the DLL, with optional
3993 ordinal number @var{integer}, or declares @var{name1} as an alias
3994 (forward) of the function @var{external-name} in the DLL.
3995 If @var{its_name} is specified, this name is used as string in export table.
3998 @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{]} *}
3999 Declares that @var{external-name} or the exported function whose
4000 ordinal number is @var{integer} is to be imported from the file
4001 @var{module-name}. If @var{internal-name} is specified then this is
4002 the name that the imported function will be referred to in the body of
4004 If @var{its_name} is specified, this name is used as string in import table.
4006 @item @code{DESCRIPTION} @var{string}
4007 Puts @var{string} into the output @file{.exp} file in the
4008 @code{.rdata} section.
4010 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4011 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4012 Generates @code{--stack} or @code{--heap}
4013 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4014 section. The linker will see this and act upon it.
4016 @item @code{CODE} @var{attr} @code{+}
4017 @item @code{DATA} @var{attr} @code{+}
4018 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4019 Generates @code{--attr} @var{section-name} @var{attr} in the output
4020 @code{.drectve} section, where @var{attr} is one of @code{READ},
4021 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4022 this and act upon it.
4027 @c man begin SEEALSO dlltool
4028 The Info pages for @file{binutils}.
4035 @cindex ELF file information
4038 @c man title readelf Displays information about ELF files.
4041 @c man begin SYNOPSIS readelf
4042 readelf [@option{-a}|@option{--all}]
4043 [@option{-h}|@option{--file-header}]
4044 [@option{-l}|@option{--program-headers}|@option{--segments}]
4045 [@option{-S}|@option{--section-headers}|@option{--sections}]
4046 [@option{-g}|@option{--section-groups}]
4047 [@option{-t}|@option{--section-details}]
4048 [@option{-e}|@option{--headers}]
4049 [@option{-s}|@option{--syms}|@option{--symbols}]
4050 [@option{--dyn-syms}]
4051 [@option{-n}|@option{--notes}]
4052 [@option{-r}|@option{--relocs}]
4053 [@option{-u}|@option{--unwind}]
4054 [@option{-d}|@option{--dynamic}]
4055 [@option{-V}|@option{--version-info}]
4056 [@option{-A}|@option{--arch-specific}]
4057 [@option{-D}|@option{--use-dynamic}]
4058 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4059 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4060 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4061 [@option{-c}|@option{--archive-index}]
4062 [@option{-w[lLiaprmfFsoRt]}|
4063 @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]]
4064 [@option{--dwarf-depth=@var{n}}]
4065 [@option{--dwarf-start=@var{n}}]
4066 [@option{-I}|@option{--histogram}]
4067 [@option{-v}|@option{--version}]
4068 [@option{-W}|@option{--wide}]
4069 [@option{-H}|@option{--help}]
4070 @var{elffile}@dots{}
4074 @c man begin DESCRIPTION readelf
4076 @command{readelf} displays information about one or more ELF format object
4077 files. The options control what particular information to display.
4079 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4080 64-bit ELF files are supported, as are archives containing ELF files.
4082 This program performs a similar function to @command{objdump} but it
4083 goes into more detail and it exists independently of the @sc{bfd}
4084 library, so if there is a bug in @sc{bfd} then readelf will not be
4089 @c man begin OPTIONS readelf
4091 The long and short forms of options, shown here as alternatives, are
4092 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4098 Equivalent to specifying @option{--file-header},
4099 @option{--program-headers}, @option{--sections}, @option{--symbols},
4100 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4101 @option{--version-info}.
4104 @itemx --file-header
4105 @cindex ELF file header information
4106 Displays the information contained in the ELF header at the start of the
4110 @itemx --program-headers
4112 @cindex ELF program header information
4113 @cindex ELF segment information
4114 Displays the information contained in the file's segment headers, if it
4119 @itemx --section-headers
4120 @cindex ELF section information
4121 Displays the information contained in the file's section headers, if it
4125 @itemx --section-groups
4126 @cindex ELF section group information
4127 Displays the information contained in the file's section groups, if it
4131 @itemx --section-details
4132 @cindex ELF section information
4133 Displays the detailed section information. Implies @option{-S}.
4138 @cindex ELF symbol table information
4139 Displays the entries in symbol table section of the file, if it has one.
4142 @cindex ELF dynamic symbol table information
4143 Displays the entries in dynamic symbol table section of the file, if it
4148 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4153 Displays the contents of the NOTE segments and/or sections, if any.
4157 @cindex ELF reloc information
4158 Displays the contents of the file's relocation section, if it has one.
4162 @cindex unwind information
4163 Displays the contents of the file's unwind section, if it has one. Only
4164 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4165 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4169 @cindex ELF dynamic section information
4170 Displays the contents of the file's dynamic section, if it has one.
4173 @itemx --version-info
4174 @cindex ELF version sections informations
4175 Displays the contents of the version sections in the file, it they
4179 @itemx --arch-specific
4180 Displays architecture-specific information in the file, if there
4184 @itemx --use-dynamic
4185 When displaying symbols, this option makes @command{readelf} use the
4186 symbol hash tables in the file's dynamic section, rather than the
4187 symbol table sections.
4189 @item -x <number or name>
4190 @itemx --hex-dump=<number or name>
4191 Displays the contents of the indicated section as a hexadecimal bytes.
4192 A number identifies a particular section by index in the section table;
4193 any other string identifies all sections with that name in the object file.
4195 @item -R <number or name>
4196 @itemx --relocated-dump=<number or name>
4197 Displays the contents of the indicated section as a hexadecimal
4198 bytes. A number identifies a particular section by index in the
4199 section table; any other string identifies all sections with that name
4200 in the object file. The contents of the section will be relocated
4201 before they are displayed.
4203 @item -p <number or name>
4204 @itemx --string-dump=<number or name>
4205 Displays the contents of the indicated section as printable strings.
4206 A number identifies a particular section by index in the section table;
4207 any other string identifies all sections with that name in the object file.
4210 @itemx --archive-index
4211 @cindex Archive file symbol index information
4212 Displays the file symbol index infomation contained in the header part
4213 of binary archives. Performs the same function as the @option{t}
4214 command to @command{ar}, but without using the BFD library. @xref{ar}.
4216 @item -w[lLiaprmfFsoRt]
4217 @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]
4218 Displays the contents of the debug sections in the file, if any are
4219 present. If one of the optional letters or words follows the switch
4220 then only data found in those specific sections will be dumped.
4222 Note that there is no single letter option to display the content of
4223 trace sections or .gdb_index.
4225 Note: the @option{=decodedline} option will display the interpreted
4226 contents of a .debug_line section whereas the @option{=rawline} option
4227 dumps the contents in a raw format.
4229 Note: the @option{=frames-interp} option will display the interpreted
4230 contents of a .debug_frame section whereas the @option{=frames} option
4231 dumps the contents in a raw format.
4233 Note: the output from the @option{=info} option can also be affected
4234 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4236 @item --dwarf-depth=@var{n}
4237 Limit the dump of the @code{.debug_info} section to @var{n} children.
4238 This is only useful with @option{--debug-dump=info}. The default is
4239 to print all DIEs; the special value 0 for @var{n} will also have this
4242 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4243 levels will not be printed. The range for @var{n} is zero-based.
4245 @item --dwarf-start=@var{n}
4246 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4247 useful with @option{--debug-dump=info}.
4249 If specified, this option will suppress printing of any header
4250 information and all DIEs before the DIE numbered @var{n}. Only
4251 siblings and children of the specified DIE will be printed.
4253 This can be used in conjunction with @option{--dwarf-depth}.
4257 Display a histogram of bucket list lengths when displaying the contents
4258 of the symbol tables.
4262 Display the version number of readelf.
4266 Don't break output lines to fit into 80 columns. By default
4267 @command{readelf} breaks section header and segment listing lines for
4268 64-bit ELF files, so that they fit into 80 columns. This option causes
4269 @command{readelf} to print each section header resp. each segment one a
4270 single line, which is far more readable on terminals wider than 80 columns.
4274 Display the command line options understood by @command{readelf}.
4281 @c man begin SEEALSO readelf
4282 objdump(1), and the Info entries for @file{binutils}.
4289 @cindex Update ELF header
4292 @c man title elfedit Update the ELF header of ELF files.
4295 @c man begin SYNOPSIS elfedit
4296 elfedit [@option{--input-mach=}@var{machine}]
4297 [@option{--input-type=}@var{type}]
4298 [@option{--input-osabi=}@var{osabi}]
4299 @option{--output-mach=}@var{machine}
4300 @option{--output-type=}@var{type}
4301 @option{--output-osabi=}@var{osabi}
4302 [@option{-v}|@option{--version}]
4303 [@option{-h}|@option{--help}]
4304 @var{elffile}@dots{}
4308 @c man begin DESCRIPTION elfedit
4310 @command{elfedit} updates the ELF header of ELF files which have
4311 the matching ELF machine and file types. The options control how and
4312 which fields in the ELF header should be updated.
4314 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4315 64-bit ELF files are supported, as are archives containing ELF files.
4318 @c man begin OPTIONS elfedit
4320 The long and short forms of options, shown here as alternatives, are
4321 equivalent. At least one of the @option{--output-mach},
4322 @option{--output-type} and @option{--output-osabi} options must be given.
4326 @itemx --input-mach=@var{machine}
4327 Set the matching input ELF machine type to @var{machine}. If
4328 @option{--input-mach} isn't specified, it will match any ELF
4331 The supported ELF machine types are, @var{L1OM}, @var{K1OM} and
4334 @itemx --output-mach=@var{machine}
4335 Change the ELF machine type in the ELF header to @var{machine}. The
4336 supported ELF machine types are the same as @option{--input-mach}.
4338 @itemx --input-type=@var{type}
4339 Set the matching input ELF file type to @var{type}. If
4340 @option{--input-type} isn't specified, it will match any ELF file types.
4342 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4344 @itemx --output-type=@var{type}
4345 Change the ELF file type in the ELF header to @var{type}. The
4346 supported ELF types are the same as @option{--input-type}.
4348 @itemx --input-osabi=@var{osabi}
4349 Set the matching input ELF file OSABI to @var{osabi}. If
4350 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4352 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4353 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4354 @var{Solaris}, @var{AIX}, @var{Irix},
4355 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4356 @var{NSK}, @var{AROS} and @var{FenixOS}.
4358 @itemx --output-osabi=@var{osabi}
4359 Change the ELF OSABI in the ELF header to @var{osabi}. The
4360 supported ELF OSABI are the same as @option{--input-osabi}.
4364 Display the version number of @command{elfedit}.
4368 Display the command line options understood by @command{elfedit}.
4375 @c man begin SEEALSO elfedit
4376 readelf(1), and the Info entries for @file{binutils}.
4380 @node Common Options
4381 @chapter Common Options
4383 The following command-line options are supported by all of the
4384 programs described in this manual.
4386 @c man begin OPTIONS
4388 @include at-file.texi
4392 Display the command-line options supported by the program.
4395 Display the version number of the program.
4397 @c man begin OPTIONS
4401 @node Selecting the Target System
4402 @chapter Selecting the Target System
4404 You can specify two aspects of the target system to the @sc{gnu}
4405 binary file utilities, each in several ways:
4415 In the following summaries, the lists of ways to specify values are in
4416 order of decreasing precedence. The ways listed first override those
4419 The commands to list valid values only list the values for which the
4420 programs you are running were configured. If they were configured with
4421 @option{--enable-targets=all}, the commands list most of the available
4422 values, but a few are left out; not all targets can be configured in at
4423 once because some of them can only be configured @dfn{native} (on hosts
4424 with the same type as the target system).
4427 * Target Selection::
4428 * Architecture Selection::
4431 @node Target Selection
4432 @section Target Selection
4434 A @dfn{target} is an object file format. A given target may be
4435 supported for multiple architectures (@pxref{Architecture Selection}).
4436 A target selection may also have variations for different operating
4437 systems or architectures.
4439 The command to list valid target values is @samp{objdump -i}
4440 (the first column of output contains the relevant information).
4442 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4443 @samp{a.out-sunos-big}.
4445 You can also specify a target using a configuration triplet. This is
4446 the same sort of name that is passed to @file{configure} to specify a
4447 target. When you use a configuration triplet as an argument, it must be
4448 fully canonicalized. You can see the canonical version of a triplet by
4449 running the shell script @file{config.sub} which is included with the
4452 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4453 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4455 @subheading @command{objdump} Target
4461 command line option: @option{-b} or @option{--target}
4464 environment variable @code{GNUTARGET}
4467 deduced from the input file
4470 @subheading @command{objcopy} and @command{strip} Input Target
4476 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4479 environment variable @code{GNUTARGET}
4482 deduced from the input file
4485 @subheading @command{objcopy} and @command{strip} Output Target
4491 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4494 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4497 environment variable @code{GNUTARGET}
4500 deduced from the input file
4503 @subheading @command{nm}, @command{size}, and @command{strings} Target
4509 command line option: @option{--target}
4512 environment variable @code{GNUTARGET}
4515 deduced from the input file
4518 @node Architecture Selection
4519 @section Architecture Selection
4521 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4522 to run. Its name may contain a colon, separating the name of the
4523 processor family from the name of the particular @sc{cpu}.
4525 The command to list valid architecture values is @samp{objdump -i} (the
4526 second column contains the relevant information).
4528 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4530 @subheading @command{objdump} Architecture
4536 command line option: @option{-m} or @option{--architecture}
4539 deduced from the input file
4542 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4548 deduced from the input file
4551 @node Reporting Bugs
4552 @chapter Reporting Bugs
4554 @cindex reporting bugs
4556 Your bug reports play an essential role in making the binary utilities
4559 Reporting a bug may help you by bringing a solution to your problem, or
4560 it may not. But in any case the principal function of a bug report is
4561 to help the entire community by making the next version of the binary
4562 utilities work better. Bug reports are your contribution to their
4565 In order for a bug report to serve its purpose, you must include the
4566 information that enables us to fix the bug.
4569 * Bug Criteria:: Have you found a bug?
4570 * Bug Reporting:: How to report bugs
4574 @section Have You Found a Bug?
4575 @cindex bug criteria
4577 If you are not sure whether you have found a bug, here are some guidelines:
4580 @cindex fatal signal
4583 If a binary utility gets a fatal signal, for any input whatever, that is
4584 a bug. Reliable utilities never crash.
4586 @cindex error on valid input
4588 If a binary utility produces an error message for valid input, that is a
4592 If you are an experienced user of binary utilities, your suggestions for
4593 improvement are welcome in any case.
4597 @section How to Report Bugs
4599 @cindex bugs, reporting
4601 A number of companies and individuals offer support for @sc{gnu}
4602 products. If you obtained the binary utilities from a support
4603 organization, we recommend you contact that organization first.
4605 You can find contact information for many support companies and
4606 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4610 In any event, we also recommend that you send bug reports for the binary
4611 utilities to @value{BUGURL}.
4614 The fundamental principle of reporting bugs usefully is this:
4615 @strong{report all the facts}. If you are not sure whether to state a
4616 fact or leave it out, state it!
4618 Often people omit facts because they think they know what causes the
4619 problem and assume that some details do not matter. Thus, you might
4620 assume that the name of a file you use in an example does not matter.
4621 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4622 a stray memory reference which happens to fetch from the location where
4623 that pathname is stored in memory; perhaps, if the pathname were
4624 different, the contents of that location would fool the utility into
4625 doing the right thing despite the bug. Play it safe and give a
4626 specific, complete example. That is the easiest thing for you to do,
4627 and the most helpful.
4629 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4630 it is new to us. Therefore, always write your bug reports on the assumption
4631 that the bug has not been reported previously.
4633 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4634 bell?'' This cannot help us fix a bug, so it is basically useless. We
4635 respond by asking for enough details to enable us to investigate.
4636 You might as well expedite matters by sending them to begin with.
4638 To enable us to fix the bug, you should include all these things:
4642 The version of the utility. Each utility announces it if you start it
4643 with the @option{--version} argument.
4645 Without this, we will not know whether there is any point in looking for
4646 the bug in the current version of the binary utilities.
4649 Any patches you may have applied to the source, including any patches
4650 made to the @code{BFD} library.
4653 The type of machine you are using, and the operating system name and
4657 What compiler (and its version) was used to compile the utilities---e.g.
4661 The command arguments you gave the utility to observe the bug. To
4662 guarantee you will not omit something important, list them all. A copy
4663 of the Makefile (or the output from make) is sufficient.
4665 If we were to try to guess the arguments, we would probably guess wrong
4666 and then we might not encounter the bug.
4669 A complete input file, or set of input files, that will reproduce the
4670 bug. If the utility is reading an object file or files, then it is
4671 generally most helpful to send the actual object files.
4673 If the source files were produced exclusively using @sc{gnu} programs
4674 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4675 may be OK to send the source files rather than the object files. In
4676 this case, be sure to say exactly what version of @command{gcc}, or
4677 whatever, was used to produce the object files. Also say how
4678 @command{gcc}, or whatever, was configured.
4681 A description of what behavior you observe that you believe is
4682 incorrect. For example, ``It gets a fatal signal.''
4684 Of course, if the bug is that the utility gets a fatal signal, then we
4685 will certainly notice it. But if the bug is incorrect output, we might
4686 not notice unless it is glaringly wrong. You might as well not give us
4687 a chance to make a mistake.
4689 Even if the problem you experience is a fatal signal, you should still
4690 say so explicitly. Suppose something strange is going on, such as your
4691 copy of the utility is out of sync, or you have encountered a bug in
4692 the C library on your system. (This has happened!) Your copy might
4693 crash and ours would not. If you told us to expect a crash, then when
4694 ours fails to crash, we would know that the bug was not happening for
4695 us. If you had not told us to expect a crash, then we would not be able
4696 to draw any conclusion from our observations.
4699 If you wish to suggest changes to the source, send us context diffs, as
4700 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4701 option. Always send diffs from the old file to the new file. If you
4702 wish to discuss something in the @command{ld} source, refer to it by
4703 context, not by line number.
4705 The line numbers in our development sources will not match those in your
4706 sources. Your line numbers would convey no useful information to us.
4709 Here are some things that are not necessary:
4713 A description of the envelope of the bug.
4715 Often people who encounter a bug spend a lot of time investigating
4716 which changes to the input file will make the bug go away and which
4717 changes will not affect it.
4719 This is often time consuming and not very useful, because the way we
4720 will find the bug is by running a single example under the debugger
4721 with breakpoints, not by pure deduction from a series of examples.
4722 We recommend that you save your time for something else.
4724 Of course, if you can find a simpler example to report @emph{instead}
4725 of the original one, that is a convenience for us. Errors in the
4726 output will be easier to spot, running under the debugger will take
4727 less time, and so on.
4729 However, simplification is not vital; if you do not want to do this,
4730 report the bug anyway and send us the entire test case you used.
4733 A patch for the bug.
4735 A patch for the bug does help us if it is a good one. But do not omit
4736 the necessary information, such as the test case, on the assumption that
4737 a patch is all we need. We might see problems with your patch and decide
4738 to fix the problem another way, or we might not understand it at all.
4740 Sometimes with programs as complicated as the binary utilities it is
4741 very hard to construct an example that will make the program follow a
4742 certain path through the code. If you do not send us the example, we
4743 will not be able to construct one, so we will not be able to verify that
4746 And if we cannot understand what bug you are trying to fix, or why your
4747 patch should be an improvement, we will not install it. A test case will
4748 help us to understand.
4751 A guess about what the bug is or what it depends on.
4753 Such guesses are usually wrong. Even we cannot guess right about such
4754 things without first using the debugger to find the facts.
4757 @node GNU Free Documentation License
4758 @appendix GNU Free Documentation License
4762 @node Binutils Index
4763 @unnumbered Binutils Index