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 Free Software Foundation, Inc.
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.3
18 or any later version published by the Free Software Foundation;
19 with no Invariant Sections, with no Front-Cover Texts, and with no
20 Back-Cover Texts. A copy of the license is included in the
21 section entitled ``GNU Free Documentation License''.
26 @dircategory Software development
28 * Binutils: (binutils). The GNU binary utilities.
31 @dircategory Individual utilities
33 * addr2line: (binutils)addr2line. Convert addresses to file and line.
34 * ar: (binutils)ar. Create, modify, and extract from archives.
35 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
36 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
37 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
38 * nlmconv: (binutils)nlmconv. Converts object code into an NLM.
39 * nm: (binutils)nm. List symbols from object files.
40 * objcopy: (binutils)objcopy. Copy and translate object files.
41 * objdump: (binutils)objdump. Display information from object files.
42 * ranlib: (binutils)ranlib. Generate index to archive contents.
43 * readelf: (binutils)readelf. Display the contents of ELF format files.
44 * size: (binutils)size. List section sizes and total size.
45 * strings: (binutils)strings. List printable strings from files.
46 * strip: (binutils)strip. Discard symbols.
47 * windmc: (binutils)windmc. Generator for Windows message resources.
48 * windres: (binutils)windres. Manipulate Windows resources.
52 @title The @sc{gnu} Binary Utilities
53 @ifset VERSION_PACKAGE
54 @subtitle @value{VERSION_PACKAGE}
56 @subtitle Version @value{VERSION}
58 @subtitle @value{UPDATED}
59 @author Roland H. Pesch
60 @author Jeffrey M. Osier
61 @author Cygnus Support
65 {\parskip=0pt \hfill Cygnus Support\par \hfill
66 Texinfo \texinfoversion\par }
69 @vskip 0pt plus 1filll
78 This brief manual contains documentation for the @sc{gnu} binary
80 @ifset VERSION_PACKAGE
81 @value{VERSION_PACKAGE}
83 version @value{VERSION}:
88 Create, modify, and extract from archives
91 List symbols from object files
94 Copy and translate object files
97 Display information from object files
100 Generate index to archive contents
103 Display the contents of ELF format files.
106 List file section sizes and total size
109 List printable strings from files
115 Demangle encoded C++ symbols (on MS-DOS, this program is named
119 Convert addresses into file names and line numbers
122 Convert object code into a Netware Loadable Module
125 Manipulate Windows resources
128 Genertor for Windows message resources
131 Create the files needed to build and use Dynamic Link Libraries
135 This document is distributed under the terms of the GNU Free
136 Documentation License version 1.3. A copy of the license is included
137 in the section entitled ``GNU Free Documentation License''.
140 * ar:: Create, modify, and extract from archives
141 * nm:: List symbols from object files
142 * objcopy:: Copy and translate object files
143 * objdump:: Display information from object files
144 * ranlib:: Generate index to archive contents
145 * readelf:: Display the contents of ELF format files
146 * size:: List section sizes and total size
147 * strings:: List printable strings from files
148 * strip:: Discard symbols
149 * c++filt:: Filter to demangle encoded C++ symbols
150 * cxxfilt: c++filt. MS-DOS name for c++filt
151 * addr2line:: Convert addresses to file and line
152 * nlmconv:: Converts object code into an NLM
153 * windres:: Manipulate Windows resources
154 * windmc:: Generator for Windows message resources
155 * dlltool:: Create files needed to build and use DLLs
156 * Common Options:: Command-line options for all utilities
157 * Selecting the Target System:: How these utilities determine the target
158 * Reporting Bugs:: Reporting Bugs
159 * GNU Free Documentation License:: GNU Free Documentation License
160 * Binutils Index:: Binutils Index
168 @cindex collections of files
170 @c man title ar create, modify, and extract from archives
173 ar [@option{--plugin} @var{name}] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
174 ar -M [ <mri-script ]
177 @c man begin DESCRIPTION ar
179 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
180 archives. An @dfn{archive} is a single file holding a collection of
181 other files in a structure that makes it possible to retrieve
182 the original individual files (called @dfn{members} of the archive).
184 The original files' contents, mode (permissions), timestamp, owner, and
185 group are preserved in the archive, and can be restored on
189 @sc{gnu} @command{ar} can maintain archives whose members have names of any
190 length; however, depending on how @command{ar} is configured on your
191 system, a limit on member-name length may be imposed for compatibility
192 with archive formats maintained with other tools. If it exists, the
193 limit is often 15 characters (typical of formats related to a.out) or 16
194 characters (typical of formats related to coff).
197 @command{ar} is considered a binary utility because archives of this sort
198 are most often used as @dfn{libraries} holding commonly needed
202 @command{ar} creates an index to the symbols defined in relocatable
203 object modules in the archive when you specify the modifier @samp{s}.
204 Once created, this index is updated in the archive whenever @command{ar}
205 makes a change to its contents (save for the @samp{q} update operation).
206 An archive with such an index speeds up linking to the library, and
207 allows routines in the library to call each other without regard to
208 their placement in the archive.
210 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
211 table. If an archive lacks the table, another form of @command{ar} called
212 @command{ranlib} can be used to add just the table.
214 @cindex thin archives
215 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
216 which contains a symbol index and references to the original copies
217 of the member files of the archives. Such an archive is useful
218 for building libraries for use within a local build, where the
219 relocatable objects are expected to remain available, and copying the
220 contents of each object would only waste time and space. Thin archives
221 are also @emph{flattened}, so that adding one or more archives to a
222 thin archive will add the elements of the nested archive individually.
223 The paths to the elements of the archive are stored relative to the
226 @cindex compatibility, @command{ar}
227 @cindex @command{ar} compatibility
228 @sc{gnu} @command{ar} is designed to be compatible with two different
229 facilities. You can control its activity using command-line options,
230 like the different varieties of @command{ar} on Unix systems; or, if you
231 specify the single command-line option @option{-M}, you can control it
232 with a script supplied via standard input, like the MRI ``librarian''
238 * ar cmdline:: Controlling @command{ar} on the command line
239 * ar scripts:: Controlling @command{ar} with a script
244 @section Controlling @command{ar} on the Command Line
247 @c man begin SYNOPSIS ar
248 ar [@option{--plugin} @var{name}] [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
252 @cindex Unix compatibility, @command{ar}
253 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
254 arguments to execute: one keyletter specifying the @emph{operation}
255 (optionally accompanied by other keyletters specifying
256 @emph{modifiers}), and the archive name to act on.
258 Most operations can also accept further @var{member} arguments,
259 specifying particular files to operate on.
261 @c man begin OPTIONS ar
263 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
264 flags @var{mod} in any order, within the first command-line argument.
266 If you wish, you may begin the first command-line argument with a
269 @cindex operations on archive
270 The @var{p} keyletter specifies what operation to execute; it may be
271 any of the following, but you must specify only one of them:
275 @cindex deleting from archive
276 @emph{Delete} modules from the archive. Specify the names of modules to
277 be deleted as @var{member}@dots{}; the archive is untouched if you
278 specify no files to delete.
280 If you specify the @samp{v} modifier, @command{ar} lists each module
284 @cindex moving in archive
285 Use this operation to @emph{move} members in an archive.
287 The ordering of members in an archive can make a difference in how
288 programs are linked using the library, if a symbol is defined in more
291 If no modifiers are used with @code{m}, any members you name in the
292 @var{member} arguments are moved to the @emph{end} of the archive;
293 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
294 specified place instead.
297 @cindex printing from archive
298 @emph{Print} the specified members of the archive, to the standard
299 output file. If the @samp{v} modifier is specified, show the member
300 name before copying its contents to standard output.
302 If you specify no @var{member} arguments, all the files in the archive are
306 @cindex quick append to archive
307 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
308 @var{archive}, without checking for replacement.
310 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
311 operation; new members are always placed at the end of the archive.
313 The modifier @samp{v} makes @command{ar} list each file as it is appended.
315 Since the point of this operation is speed, the archive's symbol table
316 index is not updated, even if it already existed; you can use @samp{ar s} or
317 @command{ranlib} explicitly to update the symbol table index.
319 However, too many different systems assume quick append rebuilds the
320 index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
323 @cindex replacement in archive
324 Insert the files @var{member}@dots{} into @var{archive} (with
325 @emph{replacement}). This operation differs from @samp{q} in that any
326 previously existing members are deleted if their names match those being
329 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
330 displays an error message, and leaves undisturbed any existing members
331 of the archive matching that name.
333 By default, new members are added at the end of the file; but you may
334 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
335 placement relative to some existing member.
337 The modifier @samp{v} used with this operation elicits a line of
338 output for each file inserted, along with one of the letters @samp{a} or
339 @samp{r} to indicate whether the file was appended (no old member
340 deleted) or replaced.
343 @cindex contents of archive
344 Display a @emph{table} listing the contents of @var{archive}, or those
345 of the files listed in @var{member}@dots{} that are present in the
346 archive. Normally only the member name is shown; if you also want to
347 see the modes (permissions), timestamp, owner, group, and size, you can
348 request that by also specifying the @samp{v} modifier.
350 If you do not specify a @var{member}, all files in the archive
353 @cindex repeated names in archive
354 @cindex name duplication in archive
355 If there is more than one file with the same name (say, @samp{fie}) in
356 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
357 first instance; to see them all, you must ask for a complete
358 listing---in our example, @samp{ar t b.a}.
359 @c WRS only; per Gumby, this is implementation-dependent, and in a more
360 @c recent case in fact works the other way.
363 @cindex extract from archive
364 @emph{Extract} members (named @var{member}) from the archive. You can
365 use the @samp{v} modifier with this operation, to request that
366 @command{ar} list each name as it extracts it.
368 If you do not specify a @var{member}, all files in the archive
371 Files cannot be extracted from a thin archive.
375 A number of modifiers (@var{mod}) may immediately follow the @var{p}
376 keyletter, to specify variations on an operation's behavior:
380 @cindex relative placement in archive
381 Add new files @emph{after} an existing member of the
382 archive. If you use the modifier @samp{a}, the name of an existing archive
383 member must be present as the @var{relpos} argument, before the
384 @var{archive} specification.
387 Add new files @emph{before} an existing member of the
388 archive. If you use the modifier @samp{b}, the name of an existing archive
389 member must be present as the @var{relpos} argument, before the
390 @var{archive} specification. (same as @samp{i}).
393 @cindex creating archives
394 @emph{Create} the archive. The specified @var{archive} is always
395 created if it did not exist, when you request an update. But a warning is
396 issued unless you specify in advance that you expect to create it, by
400 @cindex deterministic archives
401 Operate in @emph{deterministic} mode. When adding files and the archive
402 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
403 for all files. When this option is used, if @command{ar} is used with
404 identical options and identical input files, multiple runs will create
405 identical output files regardless of the input files' owners, groups,
406 file modes, or modification times.
409 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
410 names of any length. This will cause it to create archives which are
411 not compatible with the native @command{ar} program on some systems. If
412 this is a concern, the @samp{f} modifier may be used to truncate file
413 names when putting them in the archive.
416 Insert new files @emph{before} an existing member of the
417 archive. If you use the modifier @samp{i}, the name of an existing archive
418 member must be present as the @var{relpos} argument, before the
419 @var{archive} specification. (same as @samp{b}).
422 This modifier is accepted but not used.
423 @c whaffor ar l modifier??? presumably compat; with
424 @c what???---doc@@cygnus.com, 25jan91
427 Uses the @var{count} parameter. This is used if there are multiple
428 entries in the archive with the same name. Extract or delete instance
429 @var{count} of the given name from the archive.
432 @cindex dates in archive
433 Preserve the @emph{original} dates of members when extracting them. If
434 you do not specify this modifier, files extracted from the archive
435 are stamped with the time of extraction.
438 Use the full path name when matching names in the archive. @sc{gnu}
439 @command{ar} can not create an archive with a full path name (such archives
440 are not POSIX complaint), but other archive creators can. This option
441 will cause @sc{gnu} @command{ar} to match file names using a complete path
442 name, which can be convenient when extracting a single file from an
443 archive created by another tool.
446 @cindex writing archive index
447 Write an object-file index into the archive, or update an existing one,
448 even if no other change is made to the archive. You may use this modifier
449 flag either with any operation, or alone. Running @samp{ar s} on an
450 archive is equivalent to running @samp{ranlib} on it.
453 @cindex not writing archive index
454 Do not generate an archive symbol table. This can speed up building a
455 large library in several steps. The resulting archive can not be used
456 with the linker. In order to build a symbol table, you must omit the
457 @samp{S} modifier on the last execution of @samp{ar}, or you must run
458 @samp{ranlib} on the archive.
461 @cindex creating thin archive
462 Make the specified @var{archive} a @emph{thin} archive. If it already
463 exists and is a regular archive, the existing members must be present
464 in the same directory as @var{archive}.
467 @cindex updating an archive
468 Normally, @samp{ar r}@dots{} inserts all files
469 listed into the archive. If you would like to insert @emph{only} those
470 of the files you list that are newer than existing members of the same
471 names, use this modifier. The @samp{u} modifier is allowed only for the
472 operation @samp{r} (replace). In particular, the combination @samp{qu} is
473 not allowed, since checking the timestamps would lose any speed
474 advantage from the operation @samp{q}.
477 This modifier requests the @emph{verbose} version of an operation. Many
478 operations display additional information, such as filenames processed,
479 when the modifier @samp{v} is appended.
482 This modifier shows the version number of @command{ar}.
485 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
486 compatibility with AIX. The behaviour produced by this option is the
487 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
488 @samp{-X} options; in particular, it does not support @option{-X32}
489 which is the default for AIX @command{ar}.
491 The optional command line switch @option{--plugin} @var{name} causes
492 @command{ar} to load the plugin called @var{name} which adds support
493 for more file formats. This option is only available if the toolchain
494 has been built with plugin support enabled.
499 @c man begin SEEALSO ar
500 nm(1), ranlib(1), and the Info entries for @file{binutils}.
505 @section Controlling @command{ar} with a Script
508 ar -M [ <@var{script} ]
511 @cindex MRI compatibility, @command{ar}
512 @cindex scripts, @command{ar}
513 If you use the single command-line option @samp{-M} with @command{ar}, you
514 can control its operation with a rudimentary command language. This
515 form of @command{ar} operates interactively if standard input is coming
516 directly from a terminal. During interactive use, @command{ar} prompts for
517 input (the prompt is @samp{AR >}), and continues executing even after
518 errors. If you redirect standard input to a script file, no prompts are
519 issued, and @command{ar} abandons execution (with a nonzero exit code)
522 The @command{ar} command language is @emph{not} designed to be equivalent
523 to the command-line options; in fact, it provides somewhat less control
524 over archives. The only purpose of the command language is to ease the
525 transition to @sc{gnu} @command{ar} for developers who already have scripts
526 written for the MRI ``librarian'' program.
528 The syntax for the @command{ar} command language is straightforward:
531 commands are recognized in upper or lower case; for example, @code{LIST}
532 is the same as @code{list}. In the following descriptions, commands are
533 shown in upper case for clarity.
536 a single command may appear on each line; it is the first word on the
540 empty lines are allowed, and have no effect.
543 comments are allowed; text after either of the characters @samp{*}
544 or @samp{;} is ignored.
547 Whenever you use a list of names as part of the argument to an @command{ar}
548 command, you can separate the individual names with either commas or
549 blanks. Commas are shown in the explanations below, for clarity.
552 @samp{+} is used as a line continuation character; if @samp{+} appears
553 at the end of a line, the text on the following line is considered part
554 of the current command.
557 Here are the commands you can use in @command{ar} scripts, or when using
558 @command{ar} interactively. Three of them have special significance:
560 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
561 a temporary file required for most of the other commands.
563 @code{SAVE} commits the changes so far specified by the script. Prior
564 to @code{SAVE}, commands affect only the temporary copy of the current
568 @item ADDLIB @var{archive}
569 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
570 Add all the contents of @var{archive} (or, if specified, each named
571 @var{module} from @var{archive}) to the current archive.
573 Requires prior use of @code{OPEN} or @code{CREATE}.
575 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
576 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
577 @c else like "ar q..."
578 Add each named @var{member} as a module in the current archive.
580 Requires prior use of @code{OPEN} or @code{CREATE}.
583 Discard the contents of the current archive, canceling the effect of
584 any operations since the last @code{SAVE}. May be executed (with no
585 effect) even if no current archive is specified.
587 @item CREATE @var{archive}
588 Creates an archive, and makes it the current archive (required for many
589 other commands). The new archive is created with a temporary name; it
590 is not actually saved as @var{archive} until you use @code{SAVE}.
591 You can overwrite existing archives; similarly, the contents of any
592 existing file named @var{archive} will not be destroyed until @code{SAVE}.
594 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
595 Delete each listed @var{module} from the current archive; equivalent to
596 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
598 Requires prior use of @code{OPEN} or @code{CREATE}.
600 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
601 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
602 List each named @var{module} present in @var{archive}. The separate
603 command @code{VERBOSE} specifies the form of the output: when verbose
604 output is off, output is like that of @samp{ar -t @var{archive}
605 @var{module}@dots{}}. When verbose output is on, the listing is like
606 @samp{ar -tv @var{archive} @var{module}@dots{}}.
608 Output normally goes to the standard output stream; however, if you
609 specify @var{outputfile} as a final argument, @command{ar} directs the
613 Exit from @command{ar}, with a @code{0} exit code to indicate successful
614 completion. This command does not save the output file; if you have
615 changed the current archive since the last @code{SAVE} command, those
618 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
619 Extract each named @var{module} from the current archive, writing them
620 into the current directory as separate files. Equivalent to @samp{ar -x
621 @var{archive} @var{module}@dots{}}.
623 Requires prior use of @code{OPEN} or @code{CREATE}.
626 @c FIXME Tokens but no commands???
633 Display full contents of the current archive, in ``verbose'' style
634 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
635 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
636 enhancement, rather than present for MRI compatibility.)
638 Requires prior use of @code{OPEN} or @code{CREATE}.
640 @item OPEN @var{archive}
641 Opens an existing archive for use as the current archive (required for
642 many other commands). Any changes as the result of subsequent commands
643 will not actually affect @var{archive} until you next use @code{SAVE}.
645 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
646 In the current archive, replace each existing @var{module} (named in
647 the @code{REPLACE} arguments) from files in the current working directory.
648 To execute this command without errors, both the file, and the module in
649 the current archive, must exist.
651 Requires prior use of @code{OPEN} or @code{CREATE}.
654 Toggle an internal flag governing the output from @code{DIRECTORY}.
655 When the flag is on, @code{DIRECTORY} output matches output from
656 @samp{ar -tv }@dots{}.
659 Commit your changes to the current archive, and actually save it as a
660 file with the name specified in the last @code{CREATE} or @code{OPEN}
663 Requires prior use of @code{OPEN} or @code{CREATE}.
672 The @sc{gnu} linker @command{ld} is now described in a separate manual.
673 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
681 @c man title nm list symbols from object files
684 @c man begin SYNOPSIS nm
685 nm [@option{-a}|@option{--debug-syms}]
686 [@option{-g}|@option{--extern-only}][@option{--plugin} @var{name}]
687 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
688 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
689 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
690 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
691 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
692 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
693 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
694 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
695 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
699 @c man begin DESCRIPTION nm
700 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
701 If no object files are listed as arguments, @command{nm} assumes the file
704 For each symbol, @command{nm} shows:
708 The symbol value, in the radix selected by options (see below), or
709 hexadecimal by default.
712 The symbol type. At least the following types are used; others are, as
713 well, depending on the object file format. If lowercase, the symbol is
714 local; if uppercase, the symbol is global (external).
716 @c Some more detail on exactly what these symbol types are used for
720 The symbol's value is absolute, and will not be changed by further
725 The symbol is in the uninitialized data section (known as BSS).
728 The symbol is common. Common symbols are uninitialized data. When
729 linking, multiple common symbols may appear with the same name. If the
730 symbol is defined anywhere, the common symbols are treated as undefined
733 For more details on common symbols, see the discussion of
734 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
739 The symbol is in the initialized data section.
743 The symbol is in an initialized data section for small objects. Some
744 object file formats permit more efficient access to small data objects,
745 such as a global int variable as opposed to a large global array.
748 The symbol is in a section specific to the implementation of DLLs.
751 The symbol is a debugging symbol.
754 The symbols is in a stack unwind section.
758 The symbol is in a read only data section.
762 The symbol is in an uninitialized data section for small objects.
766 The symbol is in the text (code) section.
769 The symbol is undefined.
773 The symbol is a weak object. When a weak defined symbol is linked with
774 a normal defined symbol, the normal defined symbol is used with no error.
775 When a weak undefined symbol is linked and the symbol is not defined,
776 the value of the weak symbol becomes zero with no error. On some
777 systems, uppercase indicates that a default value has been specified.
781 The symbol is a weak symbol that has not been specifically tagged as a
782 weak object symbol. When a weak defined symbol is linked with a normal
783 defined symbol, the normal defined symbol is used with no error.
784 When a weak undefined symbol is linked and the symbol is not defined,
785 the value of the symbol is determined in a system-specific manner without
786 error. On some systems, uppercase indicates that a default value has been
790 The symbol is a stabs symbol in an a.out object file. In this case, the
791 next values printed are the stabs other field, the stabs desc field, and
792 the stab type. Stabs symbols are used to hold debugging information.
794 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
795 ``stabs'' debug format}.
799 The symbol type is unknown, or object file format specific.
808 @c man begin OPTIONS nm
809 The long and short forms of options, shown here as alternatives, are
815 @itemx --print-file-name
816 @cindex input file name
818 @cindex source file name
819 Precede each symbol by the name of the input file (or archive member)
820 in which it was found, rather than identifying the input file once only,
821 before all of its symbols.
825 @cindex debugging symbols
826 Display all symbols, even debugger-only symbols; normally these are not
830 @cindex @command{nm} format
831 @cindex @command{nm} compatibility
832 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
835 @itemx --demangle[=@var{style}]
836 @cindex demangling in nm
837 Decode (@dfn{demangle}) low-level symbol names into user-level names.
838 Besides removing any initial underscore prepended by the system, this
839 makes C++ function names readable. Different compilers have different
840 mangling styles. The optional demangling style argument can be used to
841 choose an appropriate demangling style for your compiler. @xref{c++filt},
842 for more information on demangling.
845 Do not demangle low-level symbol names. This is the default.
849 @cindex dynamic symbols
850 Display the dynamic symbols rather than the normal symbols. This is
851 only meaningful for dynamic objects, such as certain types of shared
854 @item -f @var{format}
855 @itemx --format=@var{format}
856 @cindex @command{nm} format
857 @cindex @command{nm} compatibility
858 Use the output format @var{format}, which can be @code{bsd},
859 @code{sysv}, or @code{posix}. The default is @code{bsd}.
860 Only the first character of @var{format} is significant; it can be
861 either upper or lower case.
865 @cindex external symbols
866 Display only external symbols.
868 @item --plugin @var{name}
870 Load the plugin called @var{name} to add support for extra target
871 types. This option is only available if the toolchain has been built
872 with plugin support enabled.
875 @itemx --line-numbers
876 @cindex symbol line numbers
877 For each symbol, use debugging information to try to find a filename and
878 line number. For a defined symbol, look for the line number of the
879 address of the symbol. For an undefined symbol, look for the line
880 number of a relocation entry which refers to the symbol. If line number
881 information can be found, print it after the other symbol information.
885 @itemx --numeric-sort
886 Sort symbols numerically by their addresses, rather than alphabetically
891 @cindex sorting symbols
892 Do not bother to sort the symbols in any order; print them in the order
897 Use the POSIX.2 standard output format instead of the default format.
898 Equivalent to @samp{-f posix}.
902 Print both value and size of defined symbols for the @code{bsd} output style.
903 This option has no effect for object formats that do not record symbol
904 sizes, unless @samp{--size-sort} is also used in which case a
905 calculated size is displayed.
909 @cindex symbol index, listing
910 When listing symbols from archive members, include the index: a mapping
911 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
912 contain definitions for which names.
915 @itemx --reverse-sort
916 Reverse the order of the sort (whether numeric or alphabetic); let the
920 Sort symbols by size. The size is computed as the difference between
921 the value of the symbol and the value of the symbol with the next higher
922 value. If the @code{bsd} output format is used the size of the symbol
923 is printed, rather than the value, and @samp{-S} must be used in order
924 both size and value to be printed.
927 Display symbols which have a target-specific special meaning. These
928 symbols are usually used by the target for some special processing and
929 are not normally helpful when included included in the normal symbol
930 lists. For example for ARM targets this option would skip the mapping
931 symbols used to mark transitions between ARM code, THUMB code and
935 @itemx --radix=@var{radix}
936 Use @var{radix} as the radix for printing the symbol values. It must be
937 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
939 @item --target=@var{bfdname}
940 @cindex object code format
941 Specify an object code format other than your system's default format.
942 @xref{Target Selection}, for more information.
945 @itemx --undefined-only
946 @cindex external symbols
947 @cindex undefined symbols
948 Display only undefined symbols (those external to each object file).
951 @cindex external symbols
952 @cindex undefined symbols
953 Display only defined symbols for each object file.
957 Show the version number of @command{nm} and exit.
960 This option is ignored for compatibility with the AIX version of
961 @command{nm}. It takes one parameter which must be the string
962 @option{32_64}. The default mode of AIX @command{nm} corresponds
963 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
966 Show a summary of the options to @command{nm} and exit.
972 @c man begin SEEALSO nm
973 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
980 @c man title objcopy copy and translate object files
983 @c man begin SYNOPSIS objcopy
984 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
985 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
986 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
987 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
988 [@option{-S}|@option{--strip-all}]
989 [@option{-g}|@option{--strip-debug}]
990 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
991 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
992 [@option{--strip-unneeded-symbol=}@var{symbolname}]
993 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
994 [@option{--localize-hidden}]
995 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
996 [@option{--globalize-symbol=}@var{symbolname}]
997 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
998 [@option{-w}|@option{--wildcard}]
999 [@option{-x}|@option{--discard-all}]
1000 [@option{-X}|@option{--discard-locals}]
1001 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1002 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
1003 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
1004 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
1005 [@option{-p}|@option{--preserve-dates}]
1006 [@option{--debugging}]
1007 [@option{--gap-fill=}@var{val}]
1008 [@option{--pad-to=}@var{address}]
1009 [@option{--set-start=}@var{val}]
1010 [@option{--adjust-start=}@var{incr}]
1011 [@option{--change-addresses=}@var{incr}]
1012 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
1013 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
1014 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
1015 [@option{--change-warnings}] [@option{--no-change-warnings}]
1016 [@option{--set-section-flags} @var{section}=@var{flags}]
1017 [@option{--add-section} @var{sectionname}=@var{filename}]
1018 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1019 [@option{--long-section-names} @{enable,disable,keep@}]
1020 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1021 [@option{--reverse-bytes=}@var{num}]
1022 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1023 [@option{--redefine-sym} @var{old}=@var{new}]
1024 [@option{--redefine-syms=}@var{filename}]
1026 [@option{--keep-symbols=}@var{filename}]
1027 [@option{--strip-symbols=}@var{filename}]
1028 [@option{--strip-unneeded-symbols=}@var{filename}]
1029 [@option{--keep-global-symbols=}@var{filename}]
1030 [@option{--localize-symbols=}@var{filename}]
1031 [@option{--globalize-symbols=}@var{filename}]
1032 [@option{--weaken-symbols=}@var{filename}]
1033 [@option{--alt-machine-code=}@var{index}]
1034 [@option{--prefix-symbols=}@var{string}]
1035 [@option{--prefix-sections=}@var{string}]
1036 [@option{--prefix-alloc-sections=}@var{string}]
1037 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1038 [@option{--keep-file-symbols}]
1039 [@option{--only-keep-debug}]
1040 [@option{--extract-symbol}]
1041 [@option{--writable-text}]
1042 [@option{--readonly-text}]
1045 [@option{--file-alignment=}@var{num}]
1046 [@option{--heap=}@var{size}]
1047 [@option{--image-base=}@var{address}]
1048 [@option{--section-alignment=}@var{num}]
1049 [@option{--stack=}@var{size}]
1050 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1051 [@option{-v}|@option{--verbose}]
1052 [@option{-V}|@option{--version}]
1053 [@option{--help}] [@option{--info}]
1054 @var{infile} [@var{outfile}]
1058 @c man begin DESCRIPTION objcopy
1059 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1060 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1061 read and write the object files. It can write the destination object
1062 file in a format different from that of the source object file. The
1063 exact behavior of @command{objcopy} is controlled by command-line options.
1064 Note that @command{objcopy} should be able to copy a fully linked file
1065 between any two formats. However, copying a relocatable object file
1066 between any two formats may not work as expected.
1068 @command{objcopy} creates temporary files to do its translations and
1069 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1070 translation work; it has access to all the formats described in @sc{bfd}
1071 and thus is able to recognize most formats without being told
1072 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1074 @command{objcopy} can be used to generate S-records by using an output
1075 target of @samp{srec} (e.g., use @samp{-O srec}).
1077 @command{objcopy} can be used to generate a raw binary file by using an
1078 output target of @samp{binary} (e.g., use @option{-O binary}). When
1079 @command{objcopy} generates a raw binary file, it will essentially produce
1080 a memory dump of the contents of the input object file. All symbols and
1081 relocation information will be discarded. The memory dump will start at
1082 the load address of the lowest section copied into the output file.
1084 When generating an S-record or a raw binary file, it may be helpful to
1085 use @option{-S} to remove sections containing debugging information. In
1086 some cases @option{-R} will be useful to remove sections which contain
1087 information that is not needed by the binary file.
1089 Note---@command{objcopy} is not able to change the endianness of its input
1090 files. If the input format has an endianness (some formats do not),
1091 @command{objcopy} can only copy the inputs into file formats that have the
1092 same endianness or which have no endianness (e.g., @samp{srec}).
1093 (However, see the @option{--reverse-bytes} option.)
1097 @c man begin OPTIONS objcopy
1101 @itemx @var{outfile}
1102 The input and output files, respectively.
1103 If you do not specify @var{outfile}, @command{objcopy} creates a
1104 temporary file and destructively renames the result with
1105 the name of @var{infile}.
1107 @item -I @var{bfdname}
1108 @itemx --input-target=@var{bfdname}
1109 Consider the source file's object format to be @var{bfdname}, rather than
1110 attempting to deduce it. @xref{Target Selection}, for more information.
1112 @item -O @var{bfdname}
1113 @itemx --output-target=@var{bfdname}
1114 Write the output file using the object format @var{bfdname}.
1115 @xref{Target Selection}, for more information.
1117 @item -F @var{bfdname}
1118 @itemx --target=@var{bfdname}
1119 Use @var{bfdname} as the object format for both the input and the output
1120 file; i.e., simply transfer data from source to destination with no
1121 translation. @xref{Target Selection}, for more information.
1123 @item -B @var{bfdarch}
1124 @itemx --binary-architecture=@var{bfdarch}
1125 Useful when transforming a raw binary input file into an object file.
1126 In this case the output architecture can be set to @var{bfdarch}. This
1127 option will be ignored if the input file has a known @var{bfdarch}. You
1128 can access this binary data inside a program by referencing the special
1129 symbols that are created by the conversion process. These symbols are
1130 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1131 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1132 an object file and then access it in your code using these symbols.
1134 @item -j @var{sectionname}
1135 @itemx --only-section=@var{sectionname}
1136 Copy only the named section from the input file to the output file.
1137 This option may be given more than once. Note that using this option
1138 inappropriately may make the output file unusable.
1140 @item -R @var{sectionname}
1141 @itemx --remove-section=@var{sectionname}
1142 Remove any section named @var{sectionname} from the output file. This
1143 option may be given more than once. Note that using this option
1144 inappropriately may make the output file unusable.
1148 Do not copy relocation and symbol information from the source file.
1151 @itemx --strip-debug
1152 Do not copy debugging symbols or sections from the source file.
1154 @item --strip-unneeded
1155 Strip all symbols that are not needed for relocation processing.
1157 @item -K @var{symbolname}
1158 @itemx --keep-symbol=@var{symbolname}
1159 When stripping symbols, keep symbol @var{symbolname} even if it would
1160 normally be stripped. This option may be given more than once.
1162 @item -N @var{symbolname}
1163 @itemx --strip-symbol=@var{symbolname}
1164 Do not copy symbol @var{symbolname} from the source file. This option
1165 may be given more than once.
1167 @item --strip-unneeded-symbol=@var{symbolname}
1168 Do not copy symbol @var{symbolname} from the source file unless it is needed
1169 by a relocation. This option may be given more than once.
1171 @item -G @var{symbolname}
1172 @itemx --keep-global-symbol=@var{symbolname}
1173 Keep only symbol @var{symbolname} global. Make all other symbols local
1174 to the file, so that they are not visible externally. This option may
1175 be given more than once.
1177 @item --localize-hidden
1178 In an ELF object, mark all symbols that have hidden or internal visibility
1179 as local. This option applies on top of symbol-specific localization options
1180 such as @option{-L}.
1182 @item -L @var{symbolname}
1183 @itemx --localize-symbol=@var{symbolname}
1184 Make symbol @var{symbolname} local to the file, so that it is not
1185 visible externally. This option may be given more than once.
1187 @item -W @var{symbolname}
1188 @itemx --weaken-symbol=@var{symbolname}
1189 Make symbol @var{symbolname} weak. This option may be given more than once.
1191 @item --globalize-symbol=@var{symbolname}
1192 Give symbol @var{symbolname} global scoping so that it is visible
1193 outside of the file in which it is defined. This option may be given
1198 Permit regular expressions in @var{symbolname}s used in other command
1199 line options. The question mark (?), asterisk (*), backslash (\) and
1200 square brackets ([]) operators can be used anywhere in the symbol
1201 name. If the first character of the symbol name is the exclamation
1202 point (!) then the sense of the switch is reversed for that symbol.
1209 would cause objcopy to weaken all symbols that start with ``fo''
1210 except for the symbol ``foo''.
1213 @itemx --discard-all
1214 Do not copy non-global symbols from the source file.
1215 @c FIXME any reason to prefer "non-global" to "local" here?
1218 @itemx --discard-locals
1219 Do not copy compiler-generated local symbols.
1220 (These usually start with @samp{L} or @samp{.}.)
1223 @itemx --byte=@var{byte}
1224 Keep only every @var{byte}th byte of the input file (header data is not
1225 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1226 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1227 option, or the default of 4. This option is useful for creating files
1228 to program @sc{rom}. It is typically used with an @code{srec} output
1231 @item -i @var{interleave}
1232 @itemx --interleave=@var{interleave}
1233 Only copy one out of every @var{interleave} bytes. Select which byte to
1234 copy with the @option{-b} or @option{--byte} option. The default is 4.
1235 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1239 @itemx --preserve-dates
1240 Set the access and modification dates of the output file to be the same
1241 as those of the input file.
1244 Convert debugging information, if possible. This is not the default
1245 because only certain debugging formats are supported, and the
1246 conversion process can be time consuming.
1248 @item --gap-fill @var{val}
1249 Fill gaps between sections with @var{val}. This operation applies to
1250 the @emph{load address} (LMA) of the sections. It is done by increasing
1251 the size of the section with the lower address, and filling in the extra
1252 space created with @var{val}.
1254 @item --pad-to @var{address}
1255 Pad the output file up to the load address @var{address}. This is
1256 done by increasing the size of the last section. The extra space is
1257 filled in with the value specified by @option{--gap-fill} (default zero).
1259 @item --set-start @var{val}
1260 Set the start address of the new file to @var{val}. Not all object file
1261 formats support setting the start address.
1263 @item --change-start @var{incr}
1264 @itemx --adjust-start @var{incr}
1265 @cindex changing start address
1266 Change the start address by adding @var{incr}. Not all object file
1267 formats support setting the start address.
1269 @item --change-addresses @var{incr}
1270 @itemx --adjust-vma @var{incr}
1271 @cindex changing object addresses
1272 Change the VMA and LMA addresses of all sections, as well as the start
1273 address, by adding @var{incr}. Some object file formats do not permit
1274 section addresses to be changed arbitrarily. Note that this does not
1275 relocate the sections; if the program expects sections to be loaded at a
1276 certain address, and this option is used to change the sections such
1277 that they are loaded at a different address, the program may fail.
1279 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1280 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1281 @cindex changing section address
1282 Set or change both the VMA address and the LMA address of the named
1283 @var{section}. If @samp{=} is used, the section address is set to
1284 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1285 section address. See the comments under @option{--change-addresses},
1286 above. If @var{section} does not exist in the input file, a warning will
1287 be issued, unless @option{--no-change-warnings} is used.
1289 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1290 @cindex changing section LMA
1291 Set or change the LMA address of the named @var{section}. The LMA
1292 address is the address where the section will be loaded into memory at
1293 program load time. Normally this is the same as the VMA address, which
1294 is the address of the section at program run time, but on some systems,
1295 especially those where a program is held in ROM, the two can be
1296 different. If @samp{=} is used, the section address is set to
1297 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1298 section address. See the comments under @option{--change-addresses},
1299 above. If @var{section} does not exist in the input file, a warning
1300 will be issued, unless @option{--no-change-warnings} is used.
1302 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1303 @cindex changing section VMA
1304 Set or change the VMA address of the named @var{section}. The VMA
1305 address is the address where the section will be located once the
1306 program has started executing. Normally this is the same as the LMA
1307 address, which is the address where the section will be loaded into
1308 memory, but on some systems, especially those where a program is held in
1309 ROM, the two can be different. If @samp{=} is used, the section address
1310 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1311 from the section address. See the comments under
1312 @option{--change-addresses}, above. If @var{section} does not exist in
1313 the input file, a warning will be issued, unless
1314 @option{--no-change-warnings} is used.
1316 @item --change-warnings
1317 @itemx --adjust-warnings
1318 If @option{--change-section-address} or @option{--change-section-lma} or
1319 @option{--change-section-vma} is used, and the named section does not
1320 exist, issue a warning. This is the default.
1322 @item --no-change-warnings
1323 @itemx --no-adjust-warnings
1324 Do not issue a warning if @option{--change-section-address} or
1325 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1326 if the named section does not exist.
1328 @item --set-section-flags @var{section}=@var{flags}
1329 Set the flags for the named section. The @var{flags} argument is a
1330 comma separated string of flag names. The recognized names are
1331 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1332 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1333 @samp{debug}. You can set the @samp{contents} flag for a section which
1334 does not have contents, but it is not meaningful to clear the
1335 @samp{contents} flag of a section which does have contents--just remove
1336 the section instead. Not all flags are meaningful for all object file
1339 @item --add-section @var{sectionname}=@var{filename}
1340 Add a new section named @var{sectionname} while copying the file. The
1341 contents of the new section are taken from the file @var{filename}. The
1342 size of the section will be the size of the file. This option only
1343 works on file formats which can support sections with arbitrary names.
1345 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1346 Rename a section from @var{oldname} to @var{newname}, optionally
1347 changing the section's flags to @var{flags} in the process. This has
1348 the advantage over usng a linker script to perform the rename in that
1349 the output stays as an object file and does not become a linked
1352 This option is particularly helpful when the input format is binary,
1353 since this will always create a section called .data. If for example,
1354 you wanted instead to create a section called .rodata containing binary
1355 data you could use the following command line to achieve it:
1358 objcopy -I binary -O <output_format> -B <architecture> \
1359 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1360 <input_binary_file> <output_object_file>
1363 @item --long-section-names @{enable,disable,keep@}
1364 Controls the handling of long section names when processing @code{COFF}
1365 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1366 is to preserve long section names if any are present in the input file.
1367 The @samp{enable} and @samp{disable} options forcibly enable or disable
1368 the use of long section names in the output object; when @samp{disable}
1369 is in effect, any long section names in the input object will be truncated.
1370 The @samp{enable} option will only emit long section names if any are
1371 present in the inputs; this is mostly the same as @samp{keep}, but it
1372 is left undefined whether the @samp{enable} option might force the
1373 creation of an empty string table in the output file.
1375 @item --change-leading-char
1376 Some object file formats use special characters at the start of
1377 symbols. The most common such character is underscore, which compilers
1378 often add before every symbol. This option tells @command{objcopy} to
1379 change the leading character of every symbol when it converts between
1380 object file formats. If the object file formats use the same leading
1381 character, this option has no effect. Otherwise, it will add a
1382 character, or remove a character, or change a character, as
1385 @item --remove-leading-char
1386 If the first character of a global symbol is a special symbol leading
1387 character used by the object file format, remove the character. The
1388 most common symbol leading character is underscore. This option will
1389 remove a leading underscore from all global symbols. This can be useful
1390 if you want to link together objects of different file formats with
1391 different conventions for symbol names. This is different from
1392 @option{--change-leading-char} because it always changes the symbol name
1393 when appropriate, regardless of the object file format of the output
1396 @item --reverse-bytes=@var{num}
1397 Reverse the bytes in a section with output contents. A section length must
1398 be evenly divisible by the value given in order for the swap to be able to
1399 take place. Reversing takes place before the interleaving is performed.
1401 This option is used typically in generating ROM images for problematic
1402 target systems. For example, on some target boards, the 32-bit words
1403 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1404 regardless of the CPU byte order. Depending on the programming model, the
1405 endianness of the ROM may need to be modified.
1407 Consider a simple file with a section containing the following eight
1408 bytes: @code{12345678}.
1410 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1411 output file would be ordered @code{21436587}.
1413 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1414 output file would be ordered @code{43218765}.
1416 By using @samp{--reverse-bytes=2} for the above example, followed by
1417 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1418 output file would be ordered @code{34127856}.
1420 @item --srec-len=@var{ival}
1421 Meaningful only for srec output. Set the maximum length of the Srecords
1422 being produced to @var{ival}. This length covers both address, data and
1425 @item --srec-forceS3
1426 Meaningful only for srec output. Avoid generation of S1/S2 records,
1427 creating S3-only record format.
1429 @item --redefine-sym @var{old}=@var{new}
1430 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1431 when one is trying link two things together for which you have no
1432 source, and there are name collisions.
1434 @item --redefine-syms=@var{filename}
1435 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1436 listed in the file @var{filename}. @var{filename} is simply a flat file,
1437 with one symbol pair per line. Line comments may be introduced by the hash
1438 character. This option may be given more than once.
1441 Change all global symbols in the file to be weak. This can be useful
1442 when building an object which will be linked against other objects using
1443 the @option{-R} option to the linker. This option is only effective when
1444 using an object file format which supports weak symbols.
1446 @item --keep-symbols=@var{filename}
1447 Apply @option{--keep-symbol} option to each symbol listed in the file
1448 @var{filename}. @var{filename} is simply a flat file, with one symbol
1449 name per line. Line comments may be introduced by the hash character.
1450 This option may be given more than once.
1452 @item --strip-symbols=@var{filename}
1453 Apply @option{--strip-symbol} option to each symbol listed in the file
1454 @var{filename}. @var{filename} is simply a flat file, with one symbol
1455 name per line. Line comments may be introduced by the hash character.
1456 This option may be given more than once.
1458 @item --strip-unneeded-symbols=@var{filename}
1459 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1460 the file @var{filename}. @var{filename} is simply a flat file, with one
1461 symbol name per line. Line comments may be introduced by the hash
1462 character. This option may be given more than once.
1464 @item --keep-global-symbols=@var{filename}
1465 Apply @option{--keep-global-symbol} option to each symbol listed in the
1466 file @var{filename}. @var{filename} is simply a flat file, with one
1467 symbol name per line. Line comments may be introduced by the hash
1468 character. This option may be given more than once.
1470 @item --localize-symbols=@var{filename}
1471 Apply @option{--localize-symbol} option to each symbol listed in the file
1472 @var{filename}. @var{filename} is simply a flat file, with one symbol
1473 name per line. Line comments may be introduced by the hash character.
1474 This option may be given more than once.
1476 @item --globalize-symbols=@var{filename}
1477 Apply @option{--globalize-symbol} option to each symbol listed in the file
1478 @var{filename}. @var{filename} is simply a flat file, with one symbol
1479 name per line. Line comments may be introduced by the hash character.
1480 This option may be given more than once.
1482 @item --weaken-symbols=@var{filename}
1483 Apply @option{--weaken-symbol} option to each symbol listed in the file
1484 @var{filename}. @var{filename} is simply a flat file, with one symbol
1485 name per line. Line comments may be introduced by the hash character.
1486 This option may be given more than once.
1488 @item --alt-machine-code=@var{index}
1489 If the output architecture has alternate machine codes, use the
1490 @var{index}th code instead of the default one. This is useful in case
1491 a machine is assigned an official code and the tool-chain adopts the
1492 new code, but other applications still depend on the original code
1493 being used. For ELF based architectures if the @var{index}
1494 alternative does not exist then the value is treated as an absolute
1495 number to be stored in the e_machine field of the ELF header.
1497 @item --writable-text
1498 Mark the output text as writable. This option isn't meaningful for all
1499 object file formats.
1501 @item --readonly-text
1502 Make the output text write protected. This option isn't meaningful for all
1503 object file formats.
1506 Mark the output file as demand paged. This option isn't meaningful for all
1507 object file formats.
1510 Mark the output file as impure. This option isn't meaningful for all
1511 object file formats.
1513 @item --prefix-symbols=@var{string}
1514 Prefix all symbols in the output file with @var{string}.
1516 @item --prefix-sections=@var{string}
1517 Prefix all section names in the output file with @var{string}.
1519 @item --prefix-alloc-sections=@var{string}
1520 Prefix all the names of all allocated sections in the output file with
1523 @item --add-gnu-debuglink=@var{path-to-file}
1524 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1525 and adds it to the output file.
1527 @item --keep-file-symbols
1528 When stripping a file, perhaps with @option{--strip-debug} or
1529 @option{--strip-unneeded}, retain any symbols specifying source file names,
1530 which would otherwise get stripped.
1532 @item --only-keep-debug
1533 Strip a file, removing contents of any sections that would not be
1534 stripped by @option{--strip-debug} and leaving the debugging sections
1535 intact. In ELF files, this preserves all note sections in the output.
1537 The intention is that this option will be used in conjunction with
1538 @option{--add-gnu-debuglink} to create a two part executable. One a
1539 stripped binary which will occupy less space in RAM and in a
1540 distribution and the second a debugging information file which is only
1541 needed if debugging abilities are required. The suggested procedure
1542 to create these files is as follows:
1544 @item --file-alignment @var{num}
1545 Specify the file alignment. Sections in the file will always begin at
1546 file offsets which are multiples of this number. This defaults to
1548 [This option is specific to PE targets.]
1550 @item --heap @var{reserve}
1551 @itemx --heap @var{reserve},@var{commit}
1552 Specify the number of bytes of memory to reserve (and optionally commit)
1553 to be used as heap for this program.
1554 [This option is specific to PE targets.]
1556 @item --image-base @var{value}
1557 Use @var{value} as the base address of your program or dll. This is
1558 the lowest memory location that will be used when your program or dll
1559 is loaded. To reduce the need to relocate and improve performance of
1560 your dlls, each should have a unique base address and not overlap any
1561 other dlls. The default is 0x400000 for executables, and 0x10000000
1563 [This option is specific to PE targets.]
1565 @item --section-alignment @var{num}
1566 Sets the section alignment. Sections in memory will always begin at
1567 addresses which are a multiple of this number. Defaults to 0x1000.
1568 [This option is specific to PE targets.]
1570 @item --stack @var{reserve}
1571 @itemx --stack @var{reserve},@var{commit}
1572 Specify the number of bytes of memory to reserve (and optionally commit)
1573 to be used as stack for this program.
1574 [This option is specific to PE targets.]
1576 @item --subsystem @var{which}
1577 @itemx --subsystem @var{which}:@var{major}
1578 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1579 Specifies the subsystem under which your program will execute. The
1580 legal values for @var{which} are @code{native}, @code{windows},
1581 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1582 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1583 the subsystem version also. Numeric values are also accepted for
1585 [This option is specific to PE targets.]
1588 @item Link the executable as normal. Assuming that is is called
1590 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1591 create a file containing the debugging info.
1592 @item Run @code{objcopy --strip-debug foo} to create a
1593 stripped executable.
1594 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1595 to add a link to the debugging info into the stripped executable.
1598 Note---the choice of @code{.dbg} as an extension for the debug info
1599 file is arbitrary. Also the @code{--only-keep-debug} step is
1600 optional. You could instead do this:
1603 @item Link the executable as normal.
1604 @item Copy @code{foo} to @code{foo.full}
1605 @item Run @code{objcopy --strip-debug foo}
1606 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1609 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1610 full executable. It does not have to be a file created by the
1611 @option{--only-keep-debug} switch.
1613 Note---this switch is only intended for use on fully linked files. It
1614 does not make sense to use it on object files where the debugging
1615 information may be incomplete. Besides the gnu_debuglink feature
1616 currently only supports the presence of one filename containing
1617 debugging information, not multiple filenames on a one-per-object-file
1620 @item --extract-symbol
1621 Keep the file's section flags and symbols but remove all section data.
1622 Specifically, the option:
1625 @item removes the contents of all sections;
1626 @item sets the size of every section to zero; and
1627 @item sets the file's start address to zero.
1630 This option is used to build a @file{.sym} file for a VxWorks kernel.
1631 It can also be a useful way of reducing the size of a @option{--just-symbols}
1636 Show the version number of @command{objcopy}.
1640 Verbose output: list all object files modified. In the case of
1641 archives, @samp{objcopy -V} lists all members of the archive.
1644 Show a summary of the options to @command{objcopy}.
1647 Display a list showing all architectures and object formats available.
1653 @c man begin SEEALSO objcopy
1654 ld(1), objdump(1), and the Info entries for @file{binutils}.
1661 @cindex object file information
1664 @c man title objdump display information from object files.
1667 @c man begin SYNOPSIS objdump
1668 objdump [@option{-a}|@option{--archive-headers}]
1669 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1670 [@option{-C}|@option{--demangle}[=@var{style}] ]
1671 [@option{-d}|@option{--disassemble}]
1672 [@option{-D}|@option{--disassemble-all}]
1673 [@option{-z}|@option{--disassemble-zeroes}]
1674 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1675 [@option{-f}|@option{--file-headers}]
1676 [@option{-F}|@option{--file-offsets}]
1677 [@option{--file-start-context}]
1678 [@option{-g}|@option{--debugging}]
1679 [@option{-e}|@option{--debugging-tags}]
1680 [@option{-h}|@option{--section-headers}|@option{--headers}]
1681 [@option{-i}|@option{--info}]
1682 [@option{-j} @var{section}|@option{--section=}@var{section}]
1683 [@option{-l}|@option{--line-numbers}]
1684 [@option{-S}|@option{--source}]
1685 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1686 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1687 [@option{-p}|@option{--private-headers}]
1688 [@option{-r}|@option{--reloc}]
1689 [@option{-R}|@option{--dynamic-reloc}]
1690 [@option{-s}|@option{--full-contents}]
1691 [@option{-W[lLiaprmfFsoR]}|
1692 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
1693 [@option{-G}|@option{--stabs}]
1694 [@option{-t}|@option{--syms}]
1695 [@option{-T}|@option{--dynamic-syms}]
1696 [@option{-x}|@option{--all-headers}]
1697 [@option{-w}|@option{--wide}]
1698 [@option{--start-address=}@var{address}]
1699 [@option{--stop-address=}@var{address}]
1700 [@option{--prefix-addresses}]
1701 [@option{--[no-]show-raw-insn}]
1702 [@option{--adjust-vma=}@var{offset}]
1703 [@option{--special-syms}]
1704 [@option{--prefix=}@var{prefix}]
1705 [@option{--prefix-strip=}@var{level}]
1706 [@option{--insn-width=}@var{width}]
1707 [@option{-V}|@option{--version}]
1708 [@option{-H}|@option{--help}]
1709 @var{objfile}@dots{}
1713 @c man begin DESCRIPTION objdump
1715 @command{objdump} displays information about one or more object files.
1716 The options control what particular information to display. This
1717 information is mostly useful to programmers who are working on the
1718 compilation tools, as opposed to programmers who just want their
1719 program to compile and work.
1721 @var{objfile}@dots{} are the object files to be examined. When you
1722 specify archives, @command{objdump} shows information on each of the member
1727 @c man begin OPTIONS objdump
1729 The long and short forms of options, shown here as alternatives, are
1730 equivalent. At least one option from the list
1731 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1735 @itemx --archive-header
1736 @cindex archive headers
1737 If any of the @var{objfile} files are archives, display the archive
1738 header information (in a format similar to @samp{ls -l}). Besides the
1739 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1740 the object file format of each archive member.
1742 @item --adjust-vma=@var{offset}
1743 @cindex section addresses in objdump
1744 @cindex VMA in objdump
1745 When dumping information, first add @var{offset} to all the section
1746 addresses. This is useful if the section addresses do not correspond to
1747 the symbol table, which can happen when putting sections at particular
1748 addresses when using a format which can not represent section addresses,
1751 @item -b @var{bfdname}
1752 @itemx --target=@var{bfdname}
1753 @cindex object code format
1754 Specify that the object-code format for the object files is
1755 @var{bfdname}. This option may not be necessary; @var{objdump} can
1756 automatically recognize many formats.
1760 objdump -b oasys -m vax -h fu.o
1763 displays summary information from the section headers (@option{-h}) of
1764 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1765 file in the format produced by Oasys compilers. You can list the
1766 formats available with the @option{-i} option.
1767 @xref{Target Selection}, for more information.
1770 @itemx --demangle[=@var{style}]
1771 @cindex demangling in objdump
1772 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1773 Besides removing any initial underscore prepended by the system, this
1774 makes C++ function names readable. Different compilers have different
1775 mangling styles. The optional demangling style argument can be used to
1776 choose an appropriate demangling style for your compiler. @xref{c++filt},
1777 for more information on demangling.
1781 Display debugging information. This attempts to parse STABS and IEEE
1782 debugging format information stored in the file and print it out using
1783 a C like syntax. If neither of these formats are found this option
1784 falls back on the @option{-W} option to print any DWARF information in
1788 @itemx --debugging-tags
1789 Like @option{-g}, but the information is generated in a format compatible
1793 @itemx --disassemble
1794 @cindex disassembling object code
1795 @cindex machine instructions
1796 Display the assembler mnemonics for the machine instructions from
1797 @var{objfile}. This option only disassembles those sections which are
1798 expected to contain instructions.
1801 @itemx --disassemble-all
1802 Like @option{-d}, but disassemble the contents of all sections, not just
1803 those expected to contain instructions.
1805 If the target is an ARM architecture this switch also has the effect
1806 of forcing the disassembler to decode pieces of data found in code
1807 sections as if they were instructions.
1809 @item --prefix-addresses
1810 When disassembling, print the complete address on each line. This is
1811 the older disassembly format.
1815 @itemx --endian=@{big|little@}
1817 @cindex disassembly endianness
1818 Specify the endianness of the object files. This only affects
1819 disassembly. This can be useful when disassembling a file format which
1820 does not describe endianness information, such as S-records.
1823 @itemx --file-headers
1824 @cindex object file header
1825 Display summary information from the overall header of
1826 each of the @var{objfile} files.
1829 @itemx --file-offsets
1830 @cindex object file offsets
1831 When disassembling sections, whenever a symbol is displayed, also
1832 display the file offset of the region of data that is about to be
1833 dumped. If zeroes are being skipped, then when disassembly resumes,
1834 tell the user how many zeroes were skipped and the file offset of the
1835 location from where the disassembly resumes. When dumping sections,
1836 display the file offset of the location from where the dump starts.
1838 @item --file-start-context
1839 @cindex source code context
1840 Specify that when displaying interlisted source code/disassembly
1841 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1842 context to the start of the file.
1845 @itemx --section-headers
1847 @cindex section headers
1848 Display summary information from the section headers of the
1851 File segments may be relocated to nonstandard addresses, for example by
1852 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1853 @command{ld}. However, some object file formats, such as a.out, do not
1854 store the starting address of the file segments. In those situations,
1855 although @command{ld} relocates the sections correctly, using @samp{objdump
1856 -h} to list the file section headers cannot show the correct addresses.
1857 Instead, it shows the usual addresses, which are implicit for the
1862 Print a summary of the options to @command{objdump} and exit.
1866 @cindex architectures available
1867 @cindex object formats available
1868 Display a list showing all architectures and object formats available
1869 for specification with @option{-b} or @option{-m}.
1872 @itemx --section=@var{name}
1873 @cindex section information
1874 Display information only for section @var{name}.
1877 @itemx --line-numbers
1878 @cindex source filenames for object files
1879 Label the display (using debugging information) with the filename and
1880 source line numbers corresponding to the object code or relocs shown.
1881 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1883 @item -m @var{machine}
1884 @itemx --architecture=@var{machine}
1885 @cindex architecture
1886 @cindex disassembly architecture
1887 Specify the architecture to use when disassembling object files. This
1888 can be useful when disassembling object files which do not describe
1889 architecture information, such as S-records. You can list the available
1890 architectures with the @option{-i} option.
1892 If the target is an ARM architecture then this switch has an
1893 additional effect. It restricts the disassembly to only those
1894 instructions supported by the architecture specified by @var{machine}.
1895 If it is necessary to use this switch because the input file does not
1896 contain any architecture information, but it is also desired to
1897 disassemble all the instructions use @option{-marm}.
1899 @item -M @var{options}
1900 @itemx --disassembler-options=@var{options}
1901 Pass target specific information to the disassembler. Only supported on
1902 some targets. If it is necessary to specify more than one
1903 disassembler option then multiple @option{-M} options can be used or
1904 can be placed together into a comma separated list.
1906 If the target is an ARM architecture then this switch can be used to
1907 select which register name set is used during disassembler. Specifying
1908 @option{-M reg-names-std} (the default) will select the register names as
1909 used in ARM's instruction set documentation, but with register 13 called
1910 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1911 @option{-M reg-names-apcs} will select the name set used by the ARM
1912 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1913 just use @samp{r} followed by the register number.
1915 There are also two variants on the APCS register naming scheme enabled
1916 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1917 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1918 with the normal register names or the special register names).
1920 This option can also be used for ARM architectures to force the
1921 disassembler to interpret all instructions as Thumb instructions by
1922 using the switch @option{--disassembler-options=force-thumb}. This can be
1923 useful when attempting to disassemble thumb code produced by other
1926 For the x86, some of the options duplicate functions of the @option{-m}
1927 switch, but allow finer grained control. Multiple selections from the
1928 following may be specified as a comma separated string.
1929 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
1930 the given architecture. @option{intel} and @option{att} select between
1931 intel syntax mode and AT&T syntax mode.
1932 @option{intel-mnemonic} and @option{att-mnemonic} select between
1933 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
1934 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
1935 @option{addr64}, @option{addr32},
1936 @option{addr16}, @option{data32} and @option{data16} specify the default
1937 address size and operand size. These four options will be overridden if
1938 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
1939 option string. Lastly, @option{suffix}, when in AT&T mode,
1940 instructs the disassembler to print a mnemonic suffix even when the
1941 suffix could be inferred by the operands.
1943 For PowerPC, @option{booke} controls the disassembly of BookE
1944 instructions. @option{32} and @option{64} select PowerPC and
1945 PowerPC64 disassembly, respectively. @option{e300} selects
1946 disassembly for the e300 family. @option{440} selects disassembly for
1947 the PowerPC 440. @option{ppcps} selects disassembly for the paired
1948 single instructions of the PPC750CL.
1950 For MIPS, this option controls the printing of instruction mnemonic
1951 names and register names in disassembled instructions. Multiple
1952 selections from the following may be specified as a comma separated
1953 string, and invalid options are ignored:
1957 Print the 'raw' instruction mnemonic instead of some pseudo
1958 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
1959 'sll' instead of 'nop', etc.
1961 @item gpr-names=@var{ABI}
1962 Print GPR (general-purpose register) names as appropriate
1963 for the specified ABI. By default, GPR names are selected according to
1964 the ABI of the binary being disassembled.
1966 @item fpr-names=@var{ABI}
1967 Print FPR (floating-point register) names as
1968 appropriate for the specified ABI. By default, FPR numbers are printed
1971 @item cp0-names=@var{ARCH}
1972 Print CP0 (system control coprocessor; coprocessor 0) register names
1973 as appropriate for the CPU or architecture specified by
1974 @var{ARCH}. By default, CP0 register names are selected according to
1975 the architecture and CPU of the binary being disassembled.
1977 @item hwr-names=@var{ARCH}
1978 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1979 as appropriate for the CPU or architecture specified by
1980 @var{ARCH}. By default, HWR names are selected according to
1981 the architecture and CPU of the binary being disassembled.
1983 @item reg-names=@var{ABI}
1984 Print GPR and FPR names as appropriate for the selected ABI.
1986 @item reg-names=@var{ARCH}
1987 Print CPU-specific register names (CP0 register and HWR names)
1988 as appropriate for the selected CPU or architecture.
1991 For any of the options listed above, @var{ABI} or
1992 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
1993 rather than names, for the selected types of registers.
1994 You can list the available values of @var{ABI} and @var{ARCH} using
1995 the @option{--help} option.
1997 For VAX, you can specify function entry addresses with @option{-M
1998 entry:0xf00ba}. You can use this multiple times to properly
1999 disassemble VAX binary files that don't contain symbol tables (like
2000 ROM dumps). In these cases, the function entry mask would otherwise
2001 be decoded as VAX instructions, which would probably lead the rest
2002 of the function being wrongly disassembled.
2005 @itemx --private-headers
2006 Print information that is specific to the object file format. The exact
2007 information printed depends upon the object file format. For some
2008 object file formats, no additional information is printed.
2012 @cindex relocation entries, in object file
2013 Print the relocation entries of the file. If used with @option{-d} or
2014 @option{-D}, the relocations are printed interspersed with the
2018 @itemx --dynamic-reloc
2019 @cindex dynamic relocation entries, in object file
2020 Print the dynamic relocation entries of the file. This is only
2021 meaningful for dynamic objects, such as certain types of shared
2022 libraries. As for @option{-r}, if used with @option{-d} or
2023 @option{-D}, the relocations are printed interspersed with the
2027 @itemx --full-contents
2028 @cindex sections, full contents
2029 @cindex object file sections
2030 Display the full contents of any sections requested. By default all
2031 non-empty sections are displayed.
2035 @cindex source disassembly
2036 @cindex disassembly, with source
2037 Display source code intermixed with disassembly, if possible. Implies
2040 @item --prefix=@var{prefix}
2041 @cindex Add prefix to absolute paths
2042 Specify @var{prefix} to add to the absolute paths when used with
2045 @item --prefix-strip=@var{level}
2046 @cindex Strip absolute paths
2047 Indicate how many initial directory names to strip off the hardwired
2048 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2050 @item --show-raw-insn
2051 When disassembling instructions, print the instruction in hex as well as
2052 in symbolic form. This is the default except when
2053 @option{--prefix-addresses} is used.
2055 @item --no-show-raw-insn
2056 When disassembling instructions, do not print the instruction bytes.
2057 This is the default when @option{--prefix-addresses} is used.
2059 @item --insn-width=@var{width}
2060 @cindex Instruction width
2061 Display @var{width} bytes on a single line when disassembling
2064 @item -W[lLiaprmfFsoR]
2065 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
2067 @cindex debug symbols
2068 Displays the contents of the debug sections in the file, if any are
2069 present. If one of the optional letters or words follows the switch
2070 then only data found in those specific sections will be dumped.
2076 @cindex debug symbols
2077 @cindex ELF object file format
2078 Display the full contents of any sections requested. Display the
2079 contents of the .stab and .stab.index and .stab.excl sections from an
2080 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2081 @code{.stab} debugging symbol-table entries are carried in an ELF
2082 section. In most other file formats, debugging symbol-table entries are
2083 interleaved with linkage symbols, and are visible in the @option{--syms}
2086 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
2087 Overview,stabs.info, The ``stabs'' debug format}.
2090 @item --start-address=@var{address}
2091 @cindex start-address
2092 Start displaying data at the specified address. This affects the output
2093 of the @option{-d}, @option{-r} and @option{-s} options.
2095 @item --stop-address=@var{address}
2096 @cindex stop-address
2097 Stop displaying data at the specified address. This affects the output
2098 of the @option{-d}, @option{-r} and @option{-s} options.
2102 @cindex symbol table entries, printing
2103 Print the symbol table entries of the file.
2104 This is similar to the information provided by the @samp{nm} program,
2105 although the display format is different. The format of the output
2106 depends upon the format of the file being dumped, but there are two main
2107 types. One looks like this:
2110 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2111 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2114 where the number inside the square brackets is the number of the entry
2115 in the symbol table, the @var{sec} number is the section number, the
2116 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2117 symbol's type, the @var{scl} number is the symbol's storage class and
2118 the @var{nx} value is the number of auxilary entries associated with
2119 the symbol. The last two fields are the symbol's value and its name.
2121 The other common output format, usually seen with ELF based files,
2125 00000000 l d .bss 00000000 .bss
2126 00000000 g .text 00000000 fred
2129 Here the first number is the symbol's value (sometimes refered to as
2130 its address). The next field is actually a set of characters and
2131 spaces indicating the flag bits that are set on the symbol. These
2132 characters are described below. Next is the section with which the
2133 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2134 not connected with any section), or @emph{*UND*} if the section is
2135 referenced in the file being dumped, but not defined there.
2137 After the section name comes another field, a number, which for common
2138 symbols is the alignment and for other symbol is the size. Finally
2139 the symbol's name is displayed.
2141 The flag characters are divided into 7 groups as follows:
2146 The symbol is local (l), global (g), neither (a space) or both (!). A
2147 symbol can be neither local or global for a variety of reasons, e.g.,
2148 because it is used for debugging, but it is probably an indication of
2149 a bug if it is ever both local and global.
2152 The symbol is weak (w) or strong (a space).
2155 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2158 The symbol is a warning (W) or a normal symbol (a space). A warning
2159 symbol's name is a message to be displayed if the symbol following the
2160 warning symbol is ever referenced.
2164 The symbol is an indirect reference to another symbol (I), a function
2165 to be evaluated during reloc processing (i) or a normal symbol (a
2170 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2171 normal symbol (a space).
2176 The symbol is the name of a function (F) or a file (f) or an object
2177 (O) or just a normal symbol (a space).
2181 @itemx --dynamic-syms
2182 @cindex dynamic symbol table entries, printing
2183 Print the dynamic symbol table entries of the file. This is only
2184 meaningful for dynamic objects, such as certain types of shared
2185 libraries. This is similar to the information provided by the @samp{nm}
2186 program when given the @option{-D} (@option{--dynamic}) option.
2188 @item --special-syms
2189 When displaying symbols include those which the target considers to be
2190 special in some way and which would not normally be of interest to the
2195 Print the version number of @command{objdump} and exit.
2198 @itemx --all-headers
2199 @cindex all header information, object file
2200 @cindex header information, all
2201 Display all available header information, including the symbol table and
2202 relocation entries. Using @option{-x} is equivalent to specifying all of
2203 @option{-a -f -h -p -r -t}.
2207 @cindex wide output, printing
2208 Format some lines for output devices that have more than 80 columns.
2209 Also do not truncate symbol names when they are displayed.
2212 @itemx --disassemble-zeroes
2213 Normally the disassembly output will skip blocks of zeroes. This
2214 option directs the disassembler to disassemble those blocks, just like
2221 @c man begin SEEALSO objdump
2222 nm(1), readelf(1), and the Info entries for @file{binutils}.
2230 @cindex archive contents
2231 @cindex symbol index
2233 @c man title ranlib generate index to archive.
2236 @c man begin SYNOPSIS ranlib
2237 ranlib [@option{-vVt}] @var{archive}
2241 @c man begin DESCRIPTION ranlib
2243 @command{ranlib} generates an index to the contents of an archive and
2244 stores it in the archive. The index lists each symbol defined by a
2245 member of an archive that is a relocatable object file.
2247 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2249 An archive with such an index speeds up linking to the library and
2250 allows routines in the library to call each other without regard to
2251 their placement in the archive.
2253 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2254 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2259 @c man begin OPTIONS ranlib
2265 Show the version number of @command{ranlib}.
2268 Update the timestamp of the symbol map of an archive.
2274 @c man begin SEEALSO ranlib
2275 ar(1), nm(1), and the Info entries for @file{binutils}.
2283 @cindex section sizes
2285 @c man title size list section sizes and total size.
2288 @c man begin SYNOPSIS size
2289 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2291 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2293 [@option{-t}|@option{--totals}]
2294 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2295 [@var{objfile}@dots{}]
2299 @c man begin DESCRIPTION size
2301 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2302 size---for each of the object or archive files @var{objfile} in its
2303 argument list. By default, one line of output is generated for each
2304 object file or each module in an archive.
2306 @var{objfile}@dots{} are the object files to be examined.
2307 If none are specified, the file @code{a.out} will be used.
2311 @c man begin OPTIONS size
2313 The command line options have the following meanings:
2318 @itemx --format=@var{compatibility}
2319 @cindex @command{size} display format
2320 Using one of these options, you can choose whether the output from @sc{gnu}
2321 @command{size} resembles output from System V @command{size} (using @option{-A},
2322 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2323 @option{--format=berkeley}). The default is the one-line format similar to
2325 @c Bonus for doc-source readers: you can also say --format=strange (or
2326 @c anything else that starts with 's') for sysv, and --format=boring (or
2327 @c anything else that starts with 'b') for Berkeley.
2329 Here is an example of the Berkeley (default) format of output from
2332 $ size --format=Berkeley ranlib size
2333 text data bss dec hex filename
2334 294880 81920 11592 388392 5ed28 ranlib
2335 294880 81920 11888 388688 5ee50 size
2339 This is the same data, but displayed closer to System V conventions:
2342 $ size --format=SysV ranlib size
2360 Show a summary of acceptable arguments and options.
2365 @itemx --radix=@var{number}
2366 @cindex @command{size} number format
2367 @cindex radix for section sizes
2368 Using one of these options, you can control whether the size of each
2369 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2370 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2371 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2372 values (8, 10, 16) are supported. The total size is always given in two
2373 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2374 octal and hexadecimal if you're using @option{-o}.
2377 Print total size of common symbols in each file. When using Berkeley
2378 format these are included in the bss size.
2382 Show totals of all objects listed (Berkeley format listing mode only).
2384 @item --target=@var{bfdname}
2385 @cindex object code format
2386 Specify that the object-code format for @var{objfile} is
2387 @var{bfdname}. This option may not be necessary; @command{size} can
2388 automatically recognize many formats.
2389 @xref{Target Selection}, for more information.
2393 Display the version number of @command{size}.
2399 @c man begin SEEALSO size
2400 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2407 @cindex listings strings
2408 @cindex printing strings
2409 @cindex strings, printing
2411 @c man title strings print the strings of printable characters in files.
2414 @c man begin SYNOPSIS strings
2415 strings [@option{-afovV}] [@option{-}@var{min-len}]
2416 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2417 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2418 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2419 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2420 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2421 [@option{--help}] [@option{--version}] @var{file}@dots{}
2425 @c man begin DESCRIPTION strings
2427 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2428 character sequences that are at least 4 characters long (or the number
2429 given with the options below) and are followed by an unprintable
2430 character. By default, it only prints the strings from the initialized
2431 and loaded sections of object files; for other types of files, it prints
2432 the strings from the whole file.
2434 @command{strings} is mainly useful for determining the contents of non-text
2439 @c man begin OPTIONS strings
2445 Do not scan only the initialized and loaded sections of object files;
2446 scan the whole files.
2449 @itemx --print-file-name
2450 Print the name of the file before each string.
2453 Print a summary of the program usage on the standard output and exit.
2455 @item -@var{min-len}
2456 @itemx -n @var{min-len}
2457 @itemx --bytes=@var{min-len}
2458 Print sequences of characters that are at least @var{min-len} characters
2459 long, instead of the default 4.
2462 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2463 act like @samp{-t d} instead. Since we can not be compatible with both
2464 ways, we simply chose one.
2466 @item -t @var{radix}
2467 @itemx --radix=@var{radix}
2468 Print the offset within the file before each string. The single
2469 character argument specifies the radix of the offset---@samp{o} for
2470 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2472 @item -e @var{encoding}
2473 @itemx --encoding=@var{encoding}
2474 Select the character encoding of the strings that are to be found.
2475 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2476 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2477 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2478 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2479 littleendian. Useful for finding wide character strings. (@samp{l}
2480 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2482 @item -T @var{bfdname}
2483 @itemx --target=@var{bfdname}
2484 @cindex object code format
2485 Specify an object code format other than your system's default format.
2486 @xref{Target Selection}, for more information.
2491 Print the program version number on the standard output and exit.
2497 @c man begin SEEALSO strings
2498 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2499 and the Info entries for @file{binutils}.
2507 @cindex removing symbols
2508 @cindex discarding symbols
2509 @cindex symbols, discarding
2511 @c man title strip Discard symbols from object files.
2514 @c man begin SYNOPSIS strip
2515 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2516 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2517 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2518 [@option{-s}|@option{--strip-all}]
2519 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2520 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2521 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2522 [@option{-w}|@option{--wildcard}]
2523 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2524 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2525 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2526 [@option{--keep-file-symbols}]
2527 [@option{--only-keep-debug}]
2528 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2529 [@option{--help}] [@option{--info}]
2530 @var{objfile}@dots{}
2534 @c man begin DESCRIPTION strip
2536 @sc{gnu} @command{strip} discards all symbols from object files
2537 @var{objfile}. The list of object files may include archives.
2538 At least one object file must be given.
2540 @command{strip} modifies the files named in its argument,
2541 rather than writing modified copies under different names.
2545 @c man begin OPTIONS strip
2548 @item -F @var{bfdname}
2549 @itemx --target=@var{bfdname}
2550 Treat the original @var{objfile} as a file with the object
2551 code format @var{bfdname}, and rewrite it in the same format.
2552 @xref{Target Selection}, for more information.
2555 Show a summary of the options to @command{strip} and exit.
2558 Display a list showing all architectures and object formats available.
2560 @item -I @var{bfdname}
2561 @itemx --input-target=@var{bfdname}
2562 Treat the original @var{objfile} as a file with the object
2563 code format @var{bfdname}.
2564 @xref{Target Selection}, for more information.
2566 @item -O @var{bfdname}
2567 @itemx --output-target=@var{bfdname}
2568 Replace @var{objfile} with a file in the output format @var{bfdname}.
2569 @xref{Target Selection}, for more information.
2571 @item -R @var{sectionname}
2572 @itemx --remove-section=@var{sectionname}
2573 Remove any section named @var{sectionname} from the output file. This
2574 option may be given more than once. Note that using this option
2575 inappropriately may make the output file unusable.
2584 @itemx --strip-debug
2585 Remove debugging symbols only.
2587 @item --strip-unneeded
2588 Remove all symbols that are not needed for relocation processing.
2590 @item -K @var{symbolname}
2591 @itemx --keep-symbol=@var{symbolname}
2592 When stripping symbols, keep symbol @var{symbolname} even if it would
2593 normally be stripped. This option may be given more than once.
2595 @item -N @var{symbolname}
2596 @itemx --strip-symbol=@var{symbolname}
2597 Remove symbol @var{symbolname} from the source file. This option may be
2598 given more than once, and may be combined with strip options other than
2602 Put the stripped output in @var{file}, rather than replacing the
2603 existing file. When this argument is used, only one @var{objfile}
2604 argument may be specified.
2607 @itemx --preserve-dates
2608 Preserve the access and modification dates of the file.
2612 Permit regular expressions in @var{symbolname}s used in other command
2613 line options. The question mark (?), asterisk (*), backslash (\) and
2614 square brackets ([]) operators can be used anywhere in the symbol
2615 name. If the first character of the symbol name is the exclamation
2616 point (!) then the sense of the switch is reversed for that symbol.
2623 would cause strip to only keep symbols that start with the letters
2624 ``fo'', but to discard the symbol ``foo''.
2627 @itemx --discard-all
2628 Remove non-global symbols.
2631 @itemx --discard-locals
2632 Remove compiler-generated local symbols.
2633 (These usually start with @samp{L} or @samp{.}.)
2635 @item --keep-file-symbols
2636 When stripping a file, perhaps with @option{--strip-debug} or
2637 @option{--strip-unneeded}, retain any symbols specifying source file names,
2638 which would otherwise get stripped.
2640 @item --only-keep-debug
2641 Strip a file, removing contents of any sections that would not be
2642 stripped by @option{--strip-debug} and leaving the debugging sections
2643 intact. In ELF files, this preserves all note sections in the output.
2645 The intention is that this option will be used in conjunction with
2646 @option{--add-gnu-debuglink} to create a two part executable. One a
2647 stripped binary which will occupy less space in RAM and in a
2648 distribution and the second a debugging information file which is only
2649 needed if debugging abilities are required. The suggested procedure
2650 to create these files is as follows:
2653 @item Link the executable as normal. Assuming that is is called
2655 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2656 create a file containing the debugging info.
2657 @item Run @code{objcopy --strip-debug foo} to create a
2658 stripped executable.
2659 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2660 to add a link to the debugging info into the stripped executable.
2663 Note---the choice of @code{.dbg} as an extension for the debug info
2664 file is arbitrary. Also the @code{--only-keep-debug} step is
2665 optional. You could instead do this:
2668 @item Link the executable as normal.
2669 @item Copy @code{foo} to @code{foo.full}
2670 @item Run @code{strip --strip-debug foo}
2671 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2674 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2675 full executable. It does not have to be a file created by the
2676 @option{--only-keep-debug} switch.
2678 Note---this switch is only intended for use on fully linked files. It
2679 does not make sense to use it on object files where the debugging
2680 information may be incomplete. Besides the gnu_debuglink feature
2681 currently only supports the presence of one filename containing
2682 debugging information, not multiple filenames on a one-per-object-file
2687 Show the version number for @command{strip}.
2691 Verbose output: list all object files modified. In the case of
2692 archives, @samp{strip -v} lists all members of the archive.
2698 @c man begin SEEALSO strip
2699 the Info entries for @file{binutils}.
2703 @node c++filt, addr2line, strip, Top
2707 @cindex demangling C++ symbols
2709 @c man title cxxfilt Demangle C++ and Java symbols.
2712 @c man begin SYNOPSIS cxxfilt
2713 c++filt [@option{-_}|@option{--strip-underscores}]
2714 [@option{-n}|@option{--no-strip-underscores}]
2715 [@option{-p}|@option{--no-params}]
2716 [@option{-t}|@option{--types}]
2717 [@option{-i}|@option{--no-verbose}]
2718 [@option{-s} @var{format}|@option{--format=}@var{format}]
2719 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2723 @c man begin DESCRIPTION cxxfilt
2726 The C++ and Java languages provide function overloading, which means
2727 that you can write many functions with the same name, providing that
2728 each function takes parameters of different types. In order to be
2729 able to distinguish these similarly named functions C++ and Java
2730 encode them into a low-level assembler name which uniquely identifies
2731 each different version. This process is known as @dfn{mangling}. The
2733 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2734 MS-DOS this program is named @command{CXXFILT}.}
2735 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2736 names into user-level names so that they can be read.
2738 Every alphanumeric word (consisting of letters, digits, underscores,
2739 dollars, or periods) seen in the input is a potential mangled name.
2740 If the name decodes into a C++ name, the C++ name replaces the
2741 low-level name in the output, otherwise the original word is output.
2742 In this way you can pass an entire assembler source file, containing
2743 mangled names, through @command{c++filt} and see the same source file
2744 containing demangled names.
2746 You can also use @command{c++filt} to decipher individual symbols by
2747 passing them on the command line:
2750 c++filt @var{symbol}
2753 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2754 names from the standard input instead. All the results are printed on
2755 the standard output. The difference between reading names from the
2756 command line versus reading names from the standard input is that
2757 command line arguments are expected to be just mangled names and no
2758 checking is performed to separate them from surrounding text. Thus
2765 will work and demangle the name to ``f()'' whereas:
2771 will not work. (Note the extra comma at the end of the mangled
2772 name which makes it invalid). This command however will work:
2775 echo _Z1fv, | c++filt -n
2778 and will display ``f(),'', i.e., the demangled name followed by a
2779 trailing comma. This behaviour is because when the names are read
2780 from the standard input it is expected that they might be part of an
2781 assembler source file where there might be extra, extraneous
2782 characters trailing after a mangled name. For example:
2785 .type _Z1fv, @@function
2790 @c man begin OPTIONS cxxfilt
2794 @itemx --strip-underscores
2795 On some systems, both the C and C++ compilers put an underscore in front
2796 of every name. For example, the C name @code{foo} gets the low-level
2797 name @code{_foo}. This option removes the initial underscore. Whether
2798 @command{c++filt} removes the underscore by default is target dependent.
2802 Prints demangled names using Java syntax. The default is to use C++
2806 @itemx --no-strip-underscores
2807 Do not remove the initial underscore.
2811 When demangling the name of a function, do not display the types of
2812 the function's parameters.
2816 Attempt to demangle types as well as function names. This is disabled
2817 by default since mangled types are normally only used internally in
2818 the compiler, and they can be confused with non-mangled names. For example,
2819 a function called ``a'' treated as a mangled type name would be
2820 demangled to ``signed char''.
2824 Do not include implementation details (if any) in the demangled
2827 @item -s @var{format}
2828 @itemx --format=@var{format}
2829 @command{c++filt} can decode various methods of mangling, used by
2830 different compilers. The argument to this option selects which
2835 Automatic selection based on executable (the default method)
2837 the one used by the @sc{gnu} C++ compiler (g++)
2839 the one used by the Lucid compiler (lcc)
2841 the one specified by the C++ Annotated Reference Manual
2843 the one used by the HP compiler (aCC)
2845 the one used by the EDG compiler
2847 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2849 the one used by the @sc{gnu} Java compiler (gcj)
2851 the one used by the @sc{gnu} Ada compiler (GNAT).
2855 Print a summary of the options to @command{c++filt} and exit.
2858 Print the version number of @command{c++filt} and exit.
2864 @c man begin SEEALSO cxxfilt
2865 the Info entries for @file{binutils}.
2870 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2871 user interface are subject to change in future releases. In particular,
2872 a command-line option may be required in the future to decode a name
2873 passed as an argument on the command line; in other words,
2876 c++filt @var{symbol}
2880 may in a future release become
2883 c++filt @var{option} @var{symbol}
2891 @cindex address to file name and line number
2893 @c man title addr2line convert addresses into file names and line numbers.
2896 @c man begin SYNOPSIS addr2line
2897 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2898 [@option{-C}|@option{--demangle}[=@var{style}]]
2899 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2900 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2901 [@option{-i}|@option{--inlines}]
2902 [@option{-j}|@option{--section=}@var{name}]
2903 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2908 @c man begin DESCRIPTION addr2line
2910 @command{addr2line} translates addresses into file names and line numbers.
2911 Given an address in an executable or an offset in a section of a relocatable
2912 object, it uses the debugging information to figure out which file name and
2913 line number are associated with it.
2915 The executable or relocatable object to use is specified with the @option{-e}
2916 option. The default is the file @file{a.out}. The section in the relocatable
2917 object to use is specified with the @option{-j} option.
2919 @command{addr2line} has two modes of operation.
2921 In the first, hexadecimal addresses are specified on the command line,
2922 and @command{addr2line} displays the file name and line number for each
2925 In the second, @command{addr2line} reads hexadecimal addresses from
2926 standard input, and prints the file name and line number for each
2927 address on standard output. In this mode, @command{addr2line} may be used
2928 in a pipe to convert dynamically chosen addresses.
2930 The format of the output is @samp{FILENAME:LINENO}. The file name and
2931 line number for each address is printed on a separate line. If the
2932 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2933 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2934 containing the address.
2936 If the file name or function name can not be determined,
2937 @command{addr2line} will print two question marks in their place. If the
2938 line number can not be determined, @command{addr2line} will print 0.
2942 @c man begin OPTIONS addr2line
2944 The long and short forms of options, shown here as alternatives, are
2948 @item -b @var{bfdname}
2949 @itemx --target=@var{bfdname}
2950 @cindex object code format
2951 Specify that the object-code format for the object files is
2955 @itemx --demangle[=@var{style}]
2956 @cindex demangling in objdump
2957 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2958 Besides removing any initial underscore prepended by the system, this
2959 makes C++ function names readable. Different compilers have different
2960 mangling styles. The optional demangling style argument can be used to
2961 choose an appropriate demangling style for your compiler. @xref{c++filt},
2962 for more information on demangling.
2964 @item -e @var{filename}
2965 @itemx --exe=@var{filename}
2966 Specify the name of the executable for which addresses should be
2967 translated. The default file is @file{a.out}.
2971 Display function names as well as file and line number information.
2975 Display only the base of each file name.
2979 If the address belongs to a function that was inlined, the source
2980 information for all enclosing scopes back to the first non-inlined
2981 function will also be printed. For example, if @code{main} inlines
2982 @code{callee1} which inlines @code{callee2}, and address is from
2983 @code{callee2}, the source information for @code{callee1} and @code{main}
2984 will also be printed.
2988 Read offsets relative to the specified section instead of absolute addresses.
2994 @c man begin SEEALSO addr2line
2995 Info entries for @file{binutils}.
3002 @command{nlmconv} converts a relocatable object file into a NetWare
3006 @command{nlmconv} currently works with @samp{i386} object
3007 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3008 object files in @sc{elf}, or @code{a.out} format@footnote{
3009 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3010 format in the Binary File Descriptor library. It has only been tested
3011 with the above formats.}.
3015 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3016 utilities, since it is only useful for NLM targets.
3019 @c man title nlmconv converts object code into an NLM.
3022 @c man begin SYNOPSIS nlmconv
3023 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3024 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3025 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3026 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3027 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3028 @var{infile} @var{outfile}
3032 @c man begin DESCRIPTION nlmconv
3034 @command{nlmconv} converts the relocatable @samp{i386} object file
3035 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3036 reading @var{headerfile} for NLM header information. For instructions
3037 on writing the NLM command file language used in header files, see the
3038 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3039 Development and Tools Overview}, which is part of the NLM Software
3040 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3041 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3044 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3047 @command{nlmconv} can perform a link step. In other words, you can list
3048 more than one object file for input if you list them in the definitions
3049 file (rather than simply specifying one input file on the command line).
3050 In this case, @command{nlmconv} calls the linker for you.
3054 @c man begin OPTIONS nlmconv
3057 @item -I @var{bfdname}
3058 @itemx --input-target=@var{bfdname}
3059 Object format of the input file. @command{nlmconv} can usually determine
3060 the format of a given file (so no default is necessary).
3061 @xref{Target Selection}, for more information.
3063 @item -O @var{bfdname}
3064 @itemx --output-target=@var{bfdname}
3065 Object format of the output file. @command{nlmconv} infers the output
3066 format based on the input format, e.g. for a @samp{i386} input file the
3067 output format is @samp{nlm32-i386}.
3068 @xref{Target Selection}, for more information.
3070 @item -T @var{headerfile}
3071 @itemx --header-file=@var{headerfile}
3072 Reads @var{headerfile} for NLM header information. For instructions on
3073 writing the NLM command file language used in header files, see@ see the
3074 @samp{linkers} section, of the @cite{NLM Development and Tools
3075 Overview}, which is part of the NLM Software Developer's Kit, available
3080 Displays (on standard error) the linker command line used by @command{nlmconv}.
3082 @item -l @var{linker}
3083 @itemx --linker=@var{linker}
3084 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3089 Prints a usage summary.
3093 Prints the version number for @command{nlmconv}.
3099 @c man begin SEEALSO nlmconv
3100 the Info entries for @file{binutils}.
3107 @command{windmc} may be used to generator Windows message resources.
3110 @emph{Warning:} @command{windmc} is not always built as part of the binary
3111 utilities, since it is only useful for Windows targets.
3114 @c man title windmc generates Windows message resources.
3117 @c man begin SYNOPSIS windres
3118 windmc [options] input-file
3122 @c man begin DESCRIPTION windmc
3124 @command{windmc} reads message definitions from an input file (.mc) and
3125 translate them into a set of output files. The output files may be of
3130 A C header file containing the message definitions.
3133 A resource file compilable by the @command{windres} tool.
3136 One or more binary files containing the resource data for a specific
3140 A C include file that maps message id's to their symbolic name.
3143 The exact description of these different formats is available in
3144 documentation from Microsoft.
3146 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3147 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3148 Windows Message Compiler.
3152 @c man begin OPTIONS windmc
3157 Specifies that the input file specified is ANSI. This is the default
3162 Specifies that messages in the output @code{bin} files should be in ANSI
3167 Specifies that @code{bin} filenames should have to be prefixed by the
3168 basename of the source file.
3172 Sets the customer bit in all message id's.
3174 @item -C @var{codepage}
3175 @itemx --codepage_in @var{codepage}
3176 Sets the default codepage to be used to convert input file to UTF16. The
3177 default is ocdepage 1252.
3180 @itemx --decimal_values
3181 Outputs the constants in the header file in decimal. Default is using
3185 @itemx --extension @var{ext}
3186 The extension for the header file. The default is .h extension.
3188 @item -F @var{target}
3189 @itemx --target @var{target}
3190 Specify the BFD format to use for a bin file as output. This
3191 is a BFD target name; you can use the @option{--help} option to see a list
3192 of supported targets. Normally @command{windmc} will use the default
3193 format, which is the first one listed by the @option{--help} option.
3195 @ref{Target Selection}.
3199 @itemx --headerdir @var{path}
3200 The target directory of the generated header file. The default is the
3205 Displays a list of command line options and then exits.
3207 @item -m @var{characters}
3208 @itemx --maxlength @var{characters}
3209 Instructs @command{windmc} to generate a warning if the length
3210 of any message exceeds the number specified.
3213 @itemx --nullterminate
3214 Terminate message text in @code{bin} files by zero. By default they are
3215 terminated by CR/LF.
3218 @itemx --hresult_use
3219 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3220 file, using HRESULT definitions. Status codes are used if the flag is not
3223 @item -O @var{codepage}
3224 @itemx --codepage_out @var{codepage}
3225 Sets the default codepage to be used to output text files. The default
3229 @itemx --rcdir @var{path}
3230 The target directory for the generated @code{rc} script and the generated
3231 @code{bin} files that the resource compiler script includes. The default
3232 is the current directory.
3236 Specifies that the input file is UTF16.
3239 @itemx --unicode_out
3240 Specifies that messages in the output @code{bin} file should be in UTF16
3241 format. This is the default behaviour.
3245 Enable verbose mode.
3249 Prints the version number for @command{windmc}.
3252 @itemx --xdgb @var{path}
3253 The path of the @code{dbg} C include file that maps message id's to the
3254 symbolic name. No such file is generated without specifying the switch.
3260 @c man begin SEEALSO windmc
3261 the Info entries for @file{binutils}.
3268 @command{windres} may be used to manipulate Windows resources.
3271 @emph{Warning:} @command{windres} is not always built as part of the binary
3272 utilities, since it is only useful for Windows targets.
3275 @c man title windres manipulate Windows resources.
3278 @c man begin SYNOPSIS windres
3279 windres [options] [input-file] [output-file]
3283 @c man begin DESCRIPTION windres
3285 @command{windres} reads resources from an input file and copies them into
3286 an output file. Either file may be in one of three formats:
3290 A text format read by the Resource Compiler.
3293 A binary format generated by the Resource Compiler.
3296 A COFF object or executable.
3299 The exact description of these different formats is available in
3300 documentation from Microsoft.
3302 When @command{windres} converts from the @code{rc} format to the @code{res}
3303 format, it is acting like the Windows Resource Compiler. When
3304 @command{windres} converts from the @code{res} format to the @code{coff}
3305 format, it is acting like the Windows @code{CVTRES} program.
3307 When @command{windres} generates an @code{rc} file, the output is similar
3308 but not identical to the format expected for the input. When an input
3309 @code{rc} file refers to an external filename, an output @code{rc} file
3310 will instead include the file contents.
3312 If the input or output format is not specified, @command{windres} will
3313 guess based on the file name, or, for the input file, the file contents.
3314 A file with an extension of @file{.rc} will be treated as an @code{rc}
3315 file, a file with an extension of @file{.res} will be treated as a
3316 @code{res} file, and a file with an extension of @file{.o} or
3317 @file{.exe} will be treated as a @code{coff} file.
3319 If no output file is specified, @command{windres} will print the resources
3320 in @code{rc} format to standard output.
3322 The normal use is for you to write an @code{rc} file, use @command{windres}
3323 to convert it to a COFF object file, and then link the COFF file into
3324 your application. This will make the resources described in the
3325 @code{rc} file available to Windows.
3329 @c man begin OPTIONS windres
3332 @item -i @var{filename}
3333 @itemx --input @var{filename}
3334 The name of the input file. If this option is not used, then
3335 @command{windres} will use the first non-option argument as the input file
3336 name. If there are no non-option arguments, then @command{windres} will
3337 read from standard input. @command{windres} can not read a COFF file from
3340 @item -o @var{filename}
3341 @itemx --output @var{filename}
3342 The name of the output file. If this option is not used, then
3343 @command{windres} will use the first non-option argument, after any used
3344 for the input file name, as the output file name. If there is no
3345 non-option argument, then @command{windres} will write to standard output.
3346 @command{windres} can not write a COFF file to standard output. Note,
3347 for compatibility with @command{rc} the option @option{-fo} is also
3348 accepted, but its use is not recommended.
3350 @item -J @var{format}
3351 @itemx --input-format @var{format}
3352 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3353 @samp{coff}. If no input format is specified, @command{windres} will
3354 guess, as described above.
3356 @item -O @var{format}
3357 @itemx --output-format @var{format}
3358 The output format to generate. @var{format} may be @samp{res},
3359 @samp{rc}, or @samp{coff}. If no output format is specified,
3360 @command{windres} will guess, as described above.
3362 @item -F @var{target}
3363 @itemx --target @var{target}
3364 Specify the BFD format to use for a COFF file as input or output. This
3365 is a BFD target name; you can use the @option{--help} option to see a list
3366 of supported targets. Normally @command{windres} will use the default
3367 format, which is the first one listed by the @option{--help} option.
3369 @ref{Target Selection}.
3372 @item --preprocessor @var{program}
3373 When @command{windres} reads an @code{rc} file, it runs it through the C
3374 preprocessor first. This option may be used to specify the preprocessor
3375 to use, including any leading arguments. The default preprocessor
3376 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3378 @item -I @var{directory}
3379 @itemx --include-dir @var{directory}
3380 Specify an include directory to use when reading an @code{rc} file.
3381 @command{windres} will pass this to the preprocessor as an @option{-I}
3382 option. @command{windres} will also search this directory when looking for
3383 files named in the @code{rc} file. If the argument passed to this command
3384 matches any of the supported @var{formats} (as described in the @option{-J}
3385 option), it will issue a deprecation warning, and behave just like the
3386 @option{-J} option. New programs should not use this behaviour. If a
3387 directory happens to match a @var{format}, simple prefix it with @samp{./}
3388 to disable the backward compatibility.
3390 @item -D @var{target}
3391 @itemx --define @var{sym}[=@var{val}]
3392 Specify a @option{-D} option to pass to the preprocessor when reading an
3395 @item -U @var{target}
3396 @itemx --undefine @var{sym}
3397 Specify a @option{-U} option to pass to the preprocessor when reading an
3401 Ignored for compatibility with rc.
3404 Enable verbose mode. This tells you what the preprocessor is if you
3408 @item --codepage @var{val}
3409 Specify the default codepage to use when reading an @code{rc} file.
3410 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3411 codepage code. The valid range is from zero up to 0xffff, but the
3412 validity of the codepage is host and configuration dependent.
3415 @item --language @var{val}
3416 Specify the default language to use when reading an @code{rc} file.
3417 @var{val} should be a hexadecimal language code. The low eight bits are
3418 the language, and the high eight bits are the sublanguage.
3420 @item --use-temp-file
3421 Use a temporary file to instead of using popen to read the output of
3422 the preprocessor. Use this option if the popen implementation is buggy
3423 on the host (eg., certain non-English language versions of Windows 95 and
3424 Windows 98 are known to have buggy popen where the output will instead
3427 @item --no-use-temp-file
3428 Use popen, not a temporary file, to read the output of the preprocessor.
3429 This is the default behaviour.
3433 Prints a usage summary.
3437 Prints the version number for @command{windres}.
3440 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3441 this will turn on parser debugging.
3447 @c man begin SEEALSO windres
3448 the Info entries for @file{binutils}.
3457 @command{dlltool} is used to create the files needed to create dynamic
3458 link libraries (DLLs) on systems which understand PE format image
3459 files such as Windows. A DLL contains an export table which contains
3460 information that the runtime loader needs to resolve references from a
3461 referencing program.
3463 The export table is generated by this program by reading in a
3464 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3465 will be in the DLL. A @file{.o} file can contain information in
3466 special @samp{.drectve} sections with export information.
3469 @emph{Note:} @command{dlltool} is not always built as part of the
3470 binary utilities, since it is only useful for those targets which
3474 @c man title dlltool Create files needed to build and use DLLs.
3477 @c man begin SYNOPSIS dlltool
3478 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3479 [@option{-b}|@option{--base-file} @var{base-file-name}]
3480 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3481 [@option{-z}|@option{--output-def} @var{def-file-name}]
3482 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3483 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3484 [@option{--exclude-symbols} @var{list}]
3485 [@option{--no-default-excludes}]
3486 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3487 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3488 [@option{-a}|@option{--add-indirect}]
3489 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3490 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3491 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3492 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3493 [@option{--use-nul-prefixed-import-tables}]
3494 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3495 [@option{-i}|@option{--interwork}]
3496 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3497 [@option{-v}|@option{--verbose}]
3498 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3499 [object-file @dots{}]
3503 @c man begin DESCRIPTION dlltool
3505 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3506 @option{-b} options as well as object files specified on the command
3507 line. It then processes these inputs and if the @option{-e} option has
3508 been specified it creates a exports file. If the @option{-l} option
3509 has been specified it creates a library file and if the @option{-z} option
3510 has been specified it creates a def file. Any or all of the @option{-e},
3511 @option{-l} and @option{-z} options can be present in one invocation of
3514 When creating a DLL, along with the source for the DLL, it is necessary
3515 to have three other files. @command{dlltool} can help with the creation of
3518 The first file is a @file{.def} file which specifies which functions are
3519 exported from the DLL, which functions the DLL imports, and so on. This
3520 is a text file and can be created by hand, or @command{dlltool} can be used
3521 to create it using the @option{-z} option. In this case @command{dlltool}
3522 will scan the object files specified on its command line looking for
3523 those functions which have been specially marked as being exported and
3524 put entries for them in the @file{.def} file it creates.
3526 In order to mark a function as being exported from a DLL, it needs to
3527 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3528 section of the object file. This can be done in C by using the
3532 asm (".section .drectve");
3533 asm (".ascii \"-export:my_func\"");
3535 int my_func (void) @{ @dots{} @}
3538 The second file needed for DLL creation is an exports file. This file
3539 is linked with the object files that make up the body of the DLL and it
3540 handles the interface between the DLL and the outside world. This is a
3541 binary file and it can be created by giving the @option{-e} option to
3542 @command{dlltool} when it is creating or reading in a @file{.def} file.
3544 The third file needed for DLL creation is the library file that programs
3545 will link with in order to access the functions in the DLL (an `import
3546 library'). This file can be created by giving the @option{-l} option to
3547 dlltool when it is creating or reading in a @file{.def} file.
3549 @command{dlltool} builds the library file by hand, but it builds the
3550 exports file by creating temporary files containing assembler statements
3551 and then assembling these. The @option{-S} command line option can be
3552 used to specify the path to the assembler that dlltool will use,
3553 and the @option{-f} option can be used to pass specific flags to that
3554 assembler. The @option{-n} can be used to prevent dlltool from deleting
3555 these temporary assembler files when it is done, and if @option{-n} is
3556 specified twice then this will prevent dlltool from deleting the
3557 temporary object files it used to build the library.
3559 Here is an example of creating a DLL from a source file @samp{dll.c} and
3560 also creating a program (from an object file called @samp{program.o})
3565 dlltool -e exports.o -l dll.lib dll.o
3566 gcc dll.o exports.o -o dll.dll
3567 gcc program.o dll.lib -o program
3571 @command{dlltool} may also be used to query an existing import library
3572 to determine the name of the DLL to which it is associated. See the
3573 description of the @option{-I} or @option{--identify} option.
3577 @c man begin OPTIONS dlltool
3579 The command line options have the following meanings:
3583 @item -d @var{filename}
3584 @itemx --input-def @var{filename}
3585 @cindex input .def file
3586 Specifies the name of a @file{.def} file to be read in and processed.
3588 @item -b @var{filename}
3589 @itemx --base-file @var{filename}
3591 Specifies the name of a base file to be read in and processed. The
3592 contents of this file will be added to the relocation section in the
3593 exports file generated by dlltool.
3595 @item -e @var{filename}
3596 @itemx --output-exp @var{filename}
3597 Specifies the name of the export file to be created by dlltool.
3599 @item -z @var{filename}
3600 @itemx --output-def @var{filename}
3601 Specifies the name of the @file{.def} file to be created by dlltool.
3603 @item -l @var{filename}
3604 @itemx --output-lib @var{filename}
3605 Specifies the name of the library file to be created by dlltool.
3607 @item --export-all-symbols
3608 Treat all global and weak defined symbols found in the input object
3609 files as symbols to be exported. There is a small list of symbols which
3610 are not exported by default; see the @option{--no-default-excludes}
3611 option. You may add to the list of symbols to not export by using the
3612 @option{--exclude-symbols} option.
3614 @item --no-export-all-symbols
3615 Only export symbols explicitly listed in an input @file{.def} file or in
3616 @samp{.drectve} sections in the input object files. This is the default
3617 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3618 attributes in the source code.
3620 @item --exclude-symbols @var{list}
3621 Do not export the symbols in @var{list}. This is a list of symbol names
3622 separated by comma or colon characters. The symbol names should not
3623 contain a leading underscore. This is only meaningful when
3624 @option{--export-all-symbols} is used.
3626 @item --no-default-excludes
3627 When @option{--export-all-symbols} is used, it will by default avoid
3628 exporting certain special symbols. The current list of symbols to avoid
3629 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3630 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3631 to go ahead and export these special symbols. This is only meaningful
3632 when @option{--export-all-symbols} is used.
3635 @itemx --as @var{path}
3636 Specifies the path, including the filename, of the assembler to be used
3637 to create the exports file.
3639 @item -f @var{options}
3640 @itemx --as-flags @var{options}
3641 Specifies any specific command line options to be passed to the
3642 assembler when building the exports file. This option will work even if
3643 the @option{-S} option is not used. This option only takes one argument,
3644 and if it occurs more than once on the command line, then later
3645 occurrences will override earlier occurrences. So if it is necessary to
3646 pass multiple options to the assembler they should be enclosed in
3650 @itemx --dll-name @var{name}
3651 Specifies the name to be stored in the @file{.def} file as the name of
3652 the DLL when the @option{-e} option is used. If this option is not
3653 present, then the filename given to the @option{-e} option will be
3654 used as the name of the DLL.
3656 @item -m @var{machine}
3657 @itemx -machine @var{machine}
3658 Specifies the type of machine for which the library file should be
3659 built. @command{dlltool} has a built in default type, depending upon how
3660 it was created, but this option can be used to override that. This is
3661 normally only useful when creating DLLs for an ARM processor, when the
3662 contents of the DLL are actually encode using Thumb instructions.
3665 @itemx --add-indirect
3666 Specifies that when @command{dlltool} is creating the exports file it
3667 should add a section which allows the exported functions to be
3668 referenced without using the import library. Whatever the hell that
3672 @itemx --add-underscore
3673 Specifies that when @command{dlltool} is creating the exports file it
3674 should prepend an underscore to the names of @emph{all} exported symbols.
3676 @item --add-stdcall-underscore
3677 Specifies that when @command{dlltool} is creating the exports file it
3678 should prepend an underscore to the names of exported @emph{stdcall}
3679 functions. Variable names and non-stdcall function names are not modified.
3680 This option is useful when creating GNU-compatible import libs for third
3681 party DLLs that were built with MS-Windows tools.
3685 Specifies that when @command{dlltool} is creating the exports file it
3686 should not append the string @samp{@@ <number>}. These numbers are
3687 called ordinal numbers and they represent another way of accessing the
3688 function in a DLL, other than by name.
3691 @itemx --add-stdcall-alias
3692 Specifies that when @command{dlltool} is creating the exports file it
3693 should add aliases for stdcall symbols without @samp{@@ <number>}
3694 in addition to the symbols with @samp{@@ <number>}.
3697 @itemx --ext-prefix-alias @var{prefix}
3698 Causes @command{dlltool} to create external aliases for all DLL
3699 imports with the specified prefix. The aliases are created for both
3700 external and import symbols with no leading underscore.
3704 Specifies that when @command{dlltool} is creating the exports and library
3705 files it should omit the @code{.idata4} section. This is for compatibility
3706 with certain operating systems.
3708 @item --use-nul-prefixed-import-tables
3709 Specifies that when @command{dlltool} is creating the exports and library
3710 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
3711 element. This emulates old gnu import library generation of
3712 @code{dlltool}. By default this option is turned off.
3716 Specifies that when @command{dlltool} is creating the exports and library
3717 files it should omit the @code{.idata5} section. This is for compatibility
3718 with certain operating systems.
3720 @item -I @var{filename}
3721 @itemx --identify @var{filename}
3722 Specifies that @command{dlltool} should inspect the import library
3723 indicated by @var{filename} and report, on @code{stdout}, the name(s)
3724 of the associated DLL(s). This can be performed in addition to any
3725 other operations indicated by the other options and arguments.
3726 @command{dlltool} fails if the import library does not exist or is not
3727 actually an import library. See also @option{--identify-strict}.
3729 @item --identify-strict
3730 Modifies the behavior of the @option{--identify} option, such
3731 that an error is reported if @var{filename} is associated with
3736 Specifies that @command{dlltool} should mark the objects in the library
3737 file and exports file that it produces as supporting interworking
3738 between ARM and Thumb code.
3742 Makes @command{dlltool} preserve the temporary assembler files it used to
3743 create the exports file. If this option is repeated then dlltool will
3744 also preserve the temporary object files it uses to create the library
3747 @item -t @var{prefix}
3748 @itemx --temp-prefix @var{prefix}
3749 Makes @command{dlltool} use @var{prefix} when constructing the names of
3750 temporary assembler and object files. By default, the temp file prefix
3751 is generated from the pid.
3755 Make dlltool describe what it is doing.
3759 Displays a list of command line options and then exits.
3763 Displays dlltool's version number and then exits.
3770 * def file format:: The format of the dlltool @file{.def} file
3773 @node def file format
3774 @section The format of the @command{dlltool} @file{.def} file
3776 A @file{.def} file contains any number of the following commands:
3780 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3781 The result is going to be named @var{name}@code{.exe}.
3783 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3784 The result is going to be named @var{name}@code{.dll}.
3786 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3787 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3788 Declares @var{name1} as an exported symbol from the DLL, with optional
3789 ordinal number @var{integer}, or declares @var{name1} as an alias
3790 (forward) of the function @var{external-name} in the DLL
3793 @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{) ) *}
3794 Declares that @var{external-name} or the exported function whose
3795 ordinal number is @var{integer} is to be imported from the file
3796 @var{module-name}. If @var{internal-name} is specified then this is
3797 the name that the imported function will be referred to in the body of
3800 @item @code{DESCRIPTION} @var{string}
3801 Puts @var{string} into the output @file{.exp} file in the
3802 @code{.rdata} section.
3804 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3805 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3806 Generates @code{--stack} or @code{--heap}
3807 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
3808 section. The linker will see this and act upon it.
3810 @item @code{CODE} @var{attr} @code{+}
3811 @item @code{DATA} @var{attr} @code{+}
3812 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3813 Generates @code{--attr} @var{section-name} @var{attr} in the output
3814 @code{.drectve} section, where @var{attr} is one of @code{READ},
3815 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3816 this and act upon it.
3821 @c man begin SEEALSO dlltool
3822 The Info pages for @file{binutils}.
3829 @cindex ELF file information
3832 @c man title readelf Displays information about ELF files.
3835 @c man begin SYNOPSIS readelf
3836 readelf [@option{-a}|@option{--all}]
3837 [@option{-h}|@option{--file-header}]
3838 [@option{-l}|@option{--program-headers}|@option{--segments}]
3839 [@option{-S}|@option{--section-headers}|@option{--sections}]
3840 [@option{-g}|@option{--section-groups}]
3841 [@option{-t}|@option{--section-details}]
3842 [@option{-e}|@option{--headers}]
3843 [@option{-s}|@option{--syms}|@option{--symbols}]
3844 [@option{-n}|@option{--notes}]
3845 [@option{-r}|@option{--relocs}]
3846 [@option{-u}|@option{--unwind}]
3847 [@option{-d}|@option{--dynamic}]
3848 [@option{-V}|@option{--version-info}]
3849 [@option{-A}|@option{--arch-specific}]
3850 [@option{-D}|@option{--use-dynamic}]
3851 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
3852 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
3853 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
3854 [@option{-c}|@option{--archive-index}]
3855 [@option{-w[lLiaprmfFsoR]}|
3856 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
3857 [@option{-I}|@option{-histogram}]
3858 [@option{-v}|@option{--version}]
3859 [@option{-W}|@option{--wide}]
3860 [@option{-H}|@option{--help}]
3861 @var{elffile}@dots{}
3865 @c man begin DESCRIPTION readelf
3867 @command{readelf} displays information about one or more ELF format object
3868 files. The options control what particular information to display.
3870 @var{elffile}@dots{} are the object files to be examined. 32-bit and
3871 64-bit ELF files are supported, as are archives containing ELF files.
3873 This program performs a similar function to @command{objdump} but it
3874 goes into more detail and it exists independently of the @sc{bfd}
3875 library, so if there is a bug in @sc{bfd} then readelf will not be
3880 @c man begin OPTIONS readelf
3882 The long and short forms of options, shown here as alternatives, are
3883 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3889 Equivalent to specifying @option{--file-header},
3890 @option{--program-headers}, @option{--sections}, @option{--symbols},
3891 @option{--relocs}, @option{--dynamic}, @option{--notes} and
3892 @option{--version-info}.
3895 @itemx --file-header
3896 @cindex ELF file header information
3897 Displays the information contained in the ELF header at the start of the
3901 @itemx --program-headers
3903 @cindex ELF program header information
3904 @cindex ELF segment information
3905 Displays the information contained in the file's segment headers, if it
3910 @itemx --section-headers
3911 @cindex ELF section information
3912 Displays the information contained in the file's section headers, if it
3916 @itemx --section-groups
3917 @cindex ELF section group information
3918 Displays the information contained in the file's section groups, if it
3922 @itemx --section-details
3923 @cindex ELF section information
3924 Displays the detailed section information. Implies @option{-S}.
3929 @cindex ELF symbol table information
3930 Displays the entries in symbol table section of the file, if it has one.
3934 Display all the headers in the file. Equivalent to @option{-h -l -S}.
3939 Displays the contents of the NOTE segments and/or sections, if any.
3943 @cindex ELF reloc information
3944 Displays the contents of the file's relocation section, if it has one.
3948 @cindex unwind information
3949 Displays the contents of the file's unwind section, if it has one. Only
3950 the unwind sections for IA64 ELF files are currently supported.
3954 @cindex ELF dynamic section information
3955 Displays the contents of the file's dynamic section, if it has one.
3958 @itemx --version-info
3959 @cindex ELF version sections informations
3960 Displays the contents of the version sections in the file, it they
3964 @itemx --arch-specific
3965 Displays architecture-specific information in the file, if there
3969 @itemx --use-dynamic
3970 When displaying symbols, this option makes @command{readelf} use the
3971 symbol table in the file's dynamic section, rather than the one in the
3974 @item -x <number or name>
3975 @itemx --hex-dump=<number or name>
3976 Displays the contents of the indicated section as a hexadecimal bytes.
3977 A number identifies a particular section by index in the section table;
3978 any other string identifies all sections with that name in the object file.
3980 @item -R <number or name>
3981 @itemx --relocated-dump=<number or name>
3982 Displays the contents of the indicated section as a hexadecimal
3983 bytes. A number identifies a particular section by index in the
3984 section table; any other string identifies all sections with that name
3985 in the object file. The contents of the section will be relocated
3986 before they are displayed.
3988 @item -p <number or name>
3989 @itemx --string-dump=<number or name>
3990 Displays the contents of the indicated section as printable strings.
3991 A number identifies a particular section by index in the section table;
3992 any other string identifies all sections with that name in the object file.
3995 @itemx --archive-index
3996 @cindex Archive file symbol index information
3997 Displays the file symbol index infomation contained in the header part
3998 of binary archives. Performs the same function as the @option{t}
3999 command to @command{ar}, but without using the BFD library. @xref{ar}.
4001 @item -w[lLiaprmfFsoR]
4002 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
4003 Displays the contents of the debug sections in the file, if any are
4004 present. If one of the optional letters or words follows the switch
4005 then only data found in those specific sections will be dumped.
4007 Note: the @option{=decodedline} option will display the interpreted
4008 contents of a .debug_line section whereas the @option{=rawline} option
4009 dumps the contents in a raw format.
4013 Display a histogram of bucket list lengths when displaying the contents
4014 of the symbol tables.
4018 Display the version number of readelf.
4022 Don't break output lines to fit into 80 columns. By default
4023 @command{readelf} breaks section header and segment listing lines for
4024 64-bit ELF files, so that they fit into 80 columns. This option causes
4025 @command{readelf} to print each section header resp. each segment one a
4026 single line, which is far more readable on terminals wider than 80 columns.
4030 Display the command line options understood by @command{readelf}.
4037 @c man begin SEEALSO readelf
4038 objdump(1), and the Info entries for @file{binutils}.
4042 @node Common Options
4043 @chapter Common Options
4045 The following command-line options are supported by all of the
4046 programs described in this manual.
4048 @c man begin OPTIONS
4050 @include at-file.texi
4054 Display the command-line options supported by the program.
4057 Display the version number of the program.
4059 @c man begin OPTIONS
4063 @node Selecting the Target System
4064 @chapter Selecting the Target System
4066 You can specify two aspects of the target system to the @sc{gnu}
4067 binary file utilities, each in several ways:
4077 In the following summaries, the lists of ways to specify values are in
4078 order of decreasing precedence. The ways listed first override those
4081 The commands to list valid values only list the values for which the
4082 programs you are running were configured. If they were configured with
4083 @option{--enable-targets=all}, the commands list most of the available
4084 values, but a few are left out; not all targets can be configured in at
4085 once because some of them can only be configured @dfn{native} (on hosts
4086 with the same type as the target system).
4089 * Target Selection::
4090 * Architecture Selection::
4093 @node Target Selection
4094 @section Target Selection
4096 A @dfn{target} is an object file format. A given target may be
4097 supported for multiple architectures (@pxref{Architecture Selection}).
4098 A target selection may also have variations for different operating
4099 systems or architectures.
4101 The command to list valid target values is @samp{objdump -i}
4102 (the first column of output contains the relevant information).
4104 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4105 @samp{a.out-sunos-big}.
4107 You can also specify a target using a configuration triplet. This is
4108 the same sort of name that is passed to @file{configure} to specify a
4109 target. When you use a configuration triplet as an argument, it must be
4110 fully canonicalized. You can see the canonical version of a triplet by
4111 running the shell script @file{config.sub} which is included with the
4114 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4115 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4117 @subheading @command{objdump} Target
4123 command line option: @option{-b} or @option{--target}
4126 environment variable @code{GNUTARGET}
4129 deduced from the input file
4132 @subheading @command{objcopy} and @command{strip} Input Target
4138 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4141 environment variable @code{GNUTARGET}
4144 deduced from the input file
4147 @subheading @command{objcopy} and @command{strip} Output Target
4153 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4156 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4159 environment variable @code{GNUTARGET}
4162 deduced from the input file
4165 @subheading @command{nm}, @command{size}, and @command{strings} Target
4171 command line option: @option{--target}
4174 environment variable @code{GNUTARGET}
4177 deduced from the input file
4180 @node Architecture Selection
4181 @section Architecture Selection
4183 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4184 to run. Its name may contain a colon, separating the name of the
4185 processor family from the name of the particular @sc{cpu}.
4187 The command to list valid architecture values is @samp{objdump -i} (the
4188 second column contains the relevant information).
4190 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4192 @subheading @command{objdump} Architecture
4198 command line option: @option{-m} or @option{--architecture}
4201 deduced from the input file
4204 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4210 deduced from the input file
4213 @node Reporting Bugs
4214 @chapter Reporting Bugs
4216 @cindex reporting bugs
4218 Your bug reports play an essential role in making the binary utilities
4221 Reporting a bug may help you by bringing a solution to your problem, or
4222 it may not. But in any case the principal function of a bug report is
4223 to help the entire community by making the next version of the binary
4224 utilities work better. Bug reports are your contribution to their
4227 In order for a bug report to serve its purpose, you must include the
4228 information that enables us to fix the bug.
4231 * Bug Criteria:: Have you found a bug?
4232 * Bug Reporting:: How to report bugs
4236 @section Have You Found a Bug?
4237 @cindex bug criteria
4239 If you are not sure whether you have found a bug, here are some guidelines:
4242 @cindex fatal signal
4245 If a binary utility gets a fatal signal, for any input whatever, that is
4246 a bug. Reliable utilities never crash.
4248 @cindex error on valid input
4250 If a binary utility produces an error message for valid input, that is a
4254 If you are an experienced user of binary utilities, your suggestions for
4255 improvement are welcome in any case.
4259 @section How to Report Bugs
4261 @cindex bugs, reporting
4263 A number of companies and individuals offer support for @sc{gnu}
4264 products. If you obtained the binary utilities from a support
4265 organization, we recommend you contact that organization first.
4267 You can find contact information for many support companies and
4268 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4272 In any event, we also recommend that you send bug reports for the binary
4273 utilities to @value{BUGURL}.
4276 The fundamental principle of reporting bugs usefully is this:
4277 @strong{report all the facts}. If you are not sure whether to state a
4278 fact or leave it out, state it!
4280 Often people omit facts because they think they know what causes the
4281 problem and assume that some details do not matter. Thus, you might
4282 assume that the name of a file you use in an example does not matter.
4283 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4284 a stray memory reference which happens to fetch from the location where
4285 that pathname is stored in memory; perhaps, if the pathname were
4286 different, the contents of that location would fool the utility into
4287 doing the right thing despite the bug. Play it safe and give a
4288 specific, complete example. That is the easiest thing for you to do,
4289 and the most helpful.
4291 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4292 it is new to us. Therefore, always write your bug reports on the assumption
4293 that the bug has not been reported previously.
4295 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4296 bell?'' This cannot help us fix a bug, so it is basically useless. We
4297 respond by asking for enough details to enable us to investigate.
4298 You might as well expedite matters by sending them to begin with.
4300 To enable us to fix the bug, you should include all these things:
4304 The version of the utility. Each utility announces it if you start it
4305 with the @option{--version} argument.
4307 Without this, we will not know whether there is any point in looking for
4308 the bug in the current version of the binary utilities.
4311 Any patches you may have applied to the source, including any patches
4312 made to the @code{BFD} library.
4315 The type of machine you are using, and the operating system name and
4319 What compiler (and its version) was used to compile the utilities---e.g.
4323 The command arguments you gave the utility to observe the bug. To
4324 guarantee you will not omit something important, list them all. A copy
4325 of the Makefile (or the output from make) is sufficient.
4327 If we were to try to guess the arguments, we would probably guess wrong
4328 and then we might not encounter the bug.
4331 A complete input file, or set of input files, that will reproduce the
4332 bug. If the utility is reading an object file or files, then it is
4333 generally most helpful to send the actual object files.
4335 If the source files were produced exclusively using @sc{gnu} programs
4336 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4337 may be OK to send the source files rather than the object files. In
4338 this case, be sure to say exactly what version of @command{gcc}, or
4339 whatever, was used to produce the object files. Also say how
4340 @command{gcc}, or whatever, was configured.
4343 A description of what behavior you observe that you believe is
4344 incorrect. For example, ``It gets a fatal signal.''
4346 Of course, if the bug is that the utility gets a fatal signal, then we
4347 will certainly notice it. But if the bug is incorrect output, we might
4348 not notice unless it is glaringly wrong. You might as well not give us
4349 a chance to make a mistake.
4351 Even if the problem you experience is a fatal signal, you should still
4352 say so explicitly. Suppose something strange is going on, such as your
4353 copy of the utility is out of sync, or you have encountered a bug in
4354 the C library on your system. (This has happened!) Your copy might
4355 crash and ours would not. If you told us to expect a crash, then when
4356 ours fails to crash, we would know that the bug was not happening for
4357 us. If you had not told us to expect a crash, then we would not be able
4358 to draw any conclusion from our observations.
4361 If you wish to suggest changes to the source, send us context diffs, as
4362 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4363 option. Always send diffs from the old file to the new file. If you
4364 wish to discuss something in the @command{ld} source, refer to it by
4365 context, not by line number.
4367 The line numbers in our development sources will not match those in your
4368 sources. Your line numbers would convey no useful information to us.
4371 Here are some things that are not necessary:
4375 A description of the envelope of the bug.
4377 Often people who encounter a bug spend a lot of time investigating
4378 which changes to the input file will make the bug go away and which
4379 changes will not affect it.
4381 This is often time consuming and not very useful, because the way we
4382 will find the bug is by running a single example under the debugger
4383 with breakpoints, not by pure deduction from a series of examples.
4384 We recommend that you save your time for something else.
4386 Of course, if you can find a simpler example to report @emph{instead}
4387 of the original one, that is a convenience for us. Errors in the
4388 output will be easier to spot, running under the debugger will take
4389 less time, and so on.
4391 However, simplification is not vital; if you do not want to do this,
4392 report the bug anyway and send us the entire test case you used.
4395 A patch for the bug.
4397 A patch for the bug does help us if it is a good one. But do not omit
4398 the necessary information, such as the test case, on the assumption that
4399 a patch is all we need. We might see problems with your patch and decide
4400 to fix the problem another way, or we might not understand it at all.
4402 Sometimes with programs as complicated as the binary utilities it is
4403 very hard to construct an example that will make the program follow a
4404 certain path through the code. If you do not send us the example, we
4405 will not be able to construct one, so we will not be able to verify that
4408 And if we cannot understand what bug you are trying to fix, or why your
4409 patch should be an improvement, we will not install it. A test case will
4410 help us to understand.
4413 A guess about what the bug is or what it depends on.
4415 Such guesses are usually wrong. Even we cannot guess right about such
4416 things without first using the debugger to find the facts.
4419 @node GNU Free Documentation License
4420 @appendix GNU Free Documentation License
4424 @node Binutils Index
4425 @unnumbered Binutils Index