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 size, not the value, of defined symbols for the @code{bsd} output format.
906 @cindex symbol index, listing
907 When listing symbols from archive members, include the index: a mapping
908 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
909 contain definitions for which names.
912 @itemx --reverse-sort
913 Reverse the order of the sort (whether numeric or alphabetic); let the
917 Sort symbols by size. The size is computed as the difference between
918 the value of the symbol and the value of the symbol with the next higher
919 value. If the @code{bsd} output format is used the size of the symbol
920 is printed, rather than the value, and @samp{-S} must be used in order
921 both size and value to be printed.
924 Display symbols which have a target-specific special meaning. These
925 symbols are usually used by the target for some special processing and
926 are not normally helpful when included included in the normal symbol
927 lists. For example for ARM targets this option would skip the mapping
928 symbols used to mark transitions between ARM code, THUMB code and
932 @itemx --radix=@var{radix}
933 Use @var{radix} as the radix for printing the symbol values. It must be
934 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
936 @item --target=@var{bfdname}
937 @cindex object code format
938 Specify an object code format other than your system's default format.
939 @xref{Target Selection}, for more information.
942 @itemx --undefined-only
943 @cindex external symbols
944 @cindex undefined symbols
945 Display only undefined symbols (those external to each object file).
948 @cindex external symbols
949 @cindex undefined symbols
950 Display only defined symbols for each object file.
954 Show the version number of @command{nm} and exit.
957 This option is ignored for compatibility with the AIX version of
958 @command{nm}. It takes one parameter which must be the string
959 @option{32_64}. The default mode of AIX @command{nm} corresponds
960 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
963 Show a summary of the options to @command{nm} and exit.
969 @c man begin SEEALSO nm
970 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
977 @c man title objcopy copy and translate object files
980 @c man begin SYNOPSIS objcopy
981 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
982 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
983 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
984 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
985 [@option{-S}|@option{--strip-all}]
986 [@option{-g}|@option{--strip-debug}]
987 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
988 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
989 [@option{--strip-unneeded-symbol=}@var{symbolname}]
990 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
991 [@option{--localize-hidden}]
992 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
993 [@option{--globalize-symbol=}@var{symbolname}]
994 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
995 [@option{-w}|@option{--wildcard}]
996 [@option{-x}|@option{--discard-all}]
997 [@option{-X}|@option{--discard-locals}]
998 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
999 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
1000 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
1001 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
1002 [@option{-p}|@option{--preserve-dates}]
1003 [@option{--debugging}]
1004 [@option{--gap-fill=}@var{val}]
1005 [@option{--pad-to=}@var{address}]
1006 [@option{--set-start=}@var{val}]
1007 [@option{--adjust-start=}@var{incr}]
1008 [@option{--change-addresses=}@var{incr}]
1009 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
1010 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
1011 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
1012 [@option{--change-warnings}] [@option{--no-change-warnings}]
1013 [@option{--set-section-flags} @var{section}=@var{flags}]
1014 [@option{--add-section} @var{sectionname}=@var{filename}]
1015 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1016 [@option{--long-section-names} @{enable,disable,keep@}]
1017 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1018 [@option{--reverse-bytes=}@var{num}]
1019 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1020 [@option{--redefine-sym} @var{old}=@var{new}]
1021 [@option{--redefine-syms=}@var{filename}]
1023 [@option{--keep-symbols=}@var{filename}]
1024 [@option{--strip-symbols=}@var{filename}]
1025 [@option{--strip-unneeded-symbols=}@var{filename}]
1026 [@option{--keep-global-symbols=}@var{filename}]
1027 [@option{--localize-symbols=}@var{filename}]
1028 [@option{--globalize-symbols=}@var{filename}]
1029 [@option{--weaken-symbols=}@var{filename}]
1030 [@option{--alt-machine-code=}@var{index}]
1031 [@option{--prefix-symbols=}@var{string}]
1032 [@option{--prefix-sections=}@var{string}]
1033 [@option{--prefix-alloc-sections=}@var{string}]
1034 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1035 [@option{--keep-file-symbols}]
1036 [@option{--only-keep-debug}]
1037 [@option{--extract-symbol}]
1038 [@option{--writable-text}]
1039 [@option{--readonly-text}]
1042 [@option{--file-alignment=}@var{num}]
1043 [@option{--heap=}@var{size}]
1044 [@option{--image-base=}@var{address}]
1045 [@option{--section-alignment=}@var{num}]
1046 [@option{--stack=}@var{size}]
1047 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1048 [@option{-v}|@option{--verbose}]
1049 [@option{-V}|@option{--version}]
1050 [@option{--help}] [@option{--info}]
1051 @var{infile} [@var{outfile}]
1055 @c man begin DESCRIPTION objcopy
1056 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1057 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1058 read and write the object files. It can write the destination object
1059 file in a format different from that of the source object file. The
1060 exact behavior of @command{objcopy} is controlled by command-line options.
1061 Note that @command{objcopy} should be able to copy a fully linked file
1062 between any two formats. However, copying a relocatable object file
1063 between any two formats may not work as expected.
1065 @command{objcopy} creates temporary files to do its translations and
1066 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1067 translation work; it has access to all the formats described in @sc{bfd}
1068 and thus is able to recognize most formats without being told
1069 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1071 @command{objcopy} can be used to generate S-records by using an output
1072 target of @samp{srec} (e.g., use @samp{-O srec}).
1074 @command{objcopy} can be used to generate a raw binary file by using an
1075 output target of @samp{binary} (e.g., use @option{-O binary}). When
1076 @command{objcopy} generates a raw binary file, it will essentially produce
1077 a memory dump of the contents of the input object file. All symbols and
1078 relocation information will be discarded. The memory dump will start at
1079 the load address of the lowest section copied into the output file.
1081 When generating an S-record or a raw binary file, it may be helpful to
1082 use @option{-S} to remove sections containing debugging information. In
1083 some cases @option{-R} will be useful to remove sections which contain
1084 information that is not needed by the binary file.
1086 Note---@command{objcopy} is not able to change the endianness of its input
1087 files. If the input format has an endianness (some formats do not),
1088 @command{objcopy} can only copy the inputs into file formats that have the
1089 same endianness or which have no endianness (e.g., @samp{srec}).
1090 (However, see the @option{--reverse-bytes} option.)
1094 @c man begin OPTIONS objcopy
1098 @itemx @var{outfile}
1099 The input and output files, respectively.
1100 If you do not specify @var{outfile}, @command{objcopy} creates a
1101 temporary file and destructively renames the result with
1102 the name of @var{infile}.
1104 @item -I @var{bfdname}
1105 @itemx --input-target=@var{bfdname}
1106 Consider the source file's object format to be @var{bfdname}, rather than
1107 attempting to deduce it. @xref{Target Selection}, for more information.
1109 @item -O @var{bfdname}
1110 @itemx --output-target=@var{bfdname}
1111 Write the output file using the object format @var{bfdname}.
1112 @xref{Target Selection}, for more information.
1114 @item -F @var{bfdname}
1115 @itemx --target=@var{bfdname}
1116 Use @var{bfdname} as the object format for both the input and the output
1117 file; i.e., simply transfer data from source to destination with no
1118 translation. @xref{Target Selection}, for more information.
1120 @item -B @var{bfdarch}
1121 @itemx --binary-architecture=@var{bfdarch}
1122 Useful when transforming a raw binary input file into an object file.
1123 In this case the output architecture can be set to @var{bfdarch}. This
1124 option will be ignored if the input file has a known @var{bfdarch}. You
1125 can access this binary data inside a program by referencing the special
1126 symbols that are created by the conversion process. These symbols are
1127 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1128 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1129 an object file and then access it in your code using these symbols.
1131 @item -j @var{sectionname}
1132 @itemx --only-section=@var{sectionname}
1133 Copy only the named section from the input file to the output file.
1134 This option may be given more than once. Note that using this option
1135 inappropriately may make the output file unusable.
1137 @item -R @var{sectionname}
1138 @itemx --remove-section=@var{sectionname}
1139 Remove any section named @var{sectionname} from the output file. This
1140 option may be given more than once. Note that using this option
1141 inappropriately may make the output file unusable.
1145 Do not copy relocation and symbol information from the source file.
1148 @itemx --strip-debug
1149 Do not copy debugging symbols or sections from the source file.
1151 @item --strip-unneeded
1152 Strip all symbols that are not needed for relocation processing.
1154 @item -K @var{symbolname}
1155 @itemx --keep-symbol=@var{symbolname}
1156 When stripping symbols, keep symbol @var{symbolname} even if it would
1157 normally be stripped. This option may be given more than once.
1159 @item -N @var{symbolname}
1160 @itemx --strip-symbol=@var{symbolname}
1161 Do not copy symbol @var{symbolname} from the source file. This option
1162 may be given more than once.
1164 @item --strip-unneeded-symbol=@var{symbolname}
1165 Do not copy symbol @var{symbolname} from the source file unless it is needed
1166 by a relocation. This option may be given more than once.
1168 @item -G @var{symbolname}
1169 @itemx --keep-global-symbol=@var{symbolname}
1170 Keep only symbol @var{symbolname} global. Make all other symbols local
1171 to the file, so that they are not visible externally. This option may
1172 be given more than once.
1174 @item --localize-hidden
1175 In an ELF object, mark all symbols that have hidden or internal visibility
1176 as local. This option applies on top of symbol-specific localization options
1177 such as @option{-L}.
1179 @item -L @var{symbolname}
1180 @itemx --localize-symbol=@var{symbolname}
1181 Make symbol @var{symbolname} local to the file, so that it is not
1182 visible externally. This option may be given more than once.
1184 @item -W @var{symbolname}
1185 @itemx --weaken-symbol=@var{symbolname}
1186 Make symbol @var{symbolname} weak. This option may be given more than once.
1188 @item --globalize-symbol=@var{symbolname}
1189 Give symbol @var{symbolname} global scoping so that it is visible
1190 outside of the file in which it is defined. This option may be given
1195 Permit regular expressions in @var{symbolname}s used in other command
1196 line options. The question mark (?), asterisk (*), backslash (\) and
1197 square brackets ([]) operators can be used anywhere in the symbol
1198 name. If the first character of the symbol name is the exclamation
1199 point (!) then the sense of the switch is reversed for that symbol.
1206 would cause objcopy to weaken all symbols that start with ``fo''
1207 except for the symbol ``foo''.
1210 @itemx --discard-all
1211 Do not copy non-global symbols from the source file.
1212 @c FIXME any reason to prefer "non-global" to "local" here?
1215 @itemx --discard-locals
1216 Do not copy compiler-generated local symbols.
1217 (These usually start with @samp{L} or @samp{.}.)
1220 @itemx --byte=@var{byte}
1221 Keep only every @var{byte}th byte of the input file (header data is not
1222 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1223 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1224 option, or the default of 4. This option is useful for creating files
1225 to program @sc{rom}. It is typically used with an @code{srec} output
1228 @item -i @var{interleave}
1229 @itemx --interleave=@var{interleave}
1230 Only copy one out of every @var{interleave} bytes. Select which byte to
1231 copy with the @option{-b} or @option{--byte} option. The default is 4.
1232 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1236 @itemx --preserve-dates
1237 Set the access and modification dates of the output file to be the same
1238 as those of the input file.
1241 Convert debugging information, if possible. This is not the default
1242 because only certain debugging formats are supported, and the
1243 conversion process can be time consuming.
1245 @item --gap-fill @var{val}
1246 Fill gaps between sections with @var{val}. This operation applies to
1247 the @emph{load address} (LMA) of the sections. It is done by increasing
1248 the size of the section with the lower address, and filling in the extra
1249 space created with @var{val}.
1251 @item --pad-to @var{address}
1252 Pad the output file up to the load address @var{address}. This is
1253 done by increasing the size of the last section. The extra space is
1254 filled in with the value specified by @option{--gap-fill} (default zero).
1256 @item --set-start @var{val}
1257 Set the start address of the new file to @var{val}. Not all object file
1258 formats support setting the start address.
1260 @item --change-start @var{incr}
1261 @itemx --adjust-start @var{incr}
1262 @cindex changing start address
1263 Change the start address by adding @var{incr}. Not all object file
1264 formats support setting the start address.
1266 @item --change-addresses @var{incr}
1267 @itemx --adjust-vma @var{incr}
1268 @cindex changing object addresses
1269 Change the VMA and LMA addresses of all sections, as well as the start
1270 address, by adding @var{incr}. Some object file formats do not permit
1271 section addresses to be changed arbitrarily. Note that this does not
1272 relocate the sections; if the program expects sections to be loaded at a
1273 certain address, and this option is used to change the sections such
1274 that they are loaded at a different address, the program may fail.
1276 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1277 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1278 @cindex changing section address
1279 Set or change both the VMA address and the LMA address of the named
1280 @var{section}. If @samp{=} is used, the section address is set to
1281 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1282 section address. See the comments under @option{--change-addresses},
1283 above. If @var{section} does not exist in the input file, a warning will
1284 be issued, unless @option{--no-change-warnings} is used.
1286 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1287 @cindex changing section LMA
1288 Set or change the LMA address of the named @var{section}. The LMA
1289 address is the address where the section will be loaded into memory at
1290 program load time. Normally this is the same as the VMA address, which
1291 is the address of the section at program run time, but on some systems,
1292 especially those where a program is held in ROM, the two can be
1293 different. If @samp{=} is used, the section address is set to
1294 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1295 section address. See the comments under @option{--change-addresses},
1296 above. If @var{section} does not exist in the input file, a warning
1297 will be issued, unless @option{--no-change-warnings} is used.
1299 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1300 @cindex changing section VMA
1301 Set or change the VMA address of the named @var{section}. The VMA
1302 address is the address where the section will be located once the
1303 program has started executing. Normally this is the same as the LMA
1304 address, which is the address where the section will be loaded into
1305 memory, but on some systems, especially those where a program is held in
1306 ROM, the two can be different. If @samp{=} is used, the section address
1307 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1308 from the section address. See the comments under
1309 @option{--change-addresses}, above. If @var{section} does not exist in
1310 the input file, a warning will be issued, unless
1311 @option{--no-change-warnings} is used.
1313 @item --change-warnings
1314 @itemx --adjust-warnings
1315 If @option{--change-section-address} or @option{--change-section-lma} or
1316 @option{--change-section-vma} is used, and the named section does not
1317 exist, issue a warning. This is the default.
1319 @item --no-change-warnings
1320 @itemx --no-adjust-warnings
1321 Do not issue a warning if @option{--change-section-address} or
1322 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1323 if the named section does not exist.
1325 @item --set-section-flags @var{section}=@var{flags}
1326 Set the flags for the named section. The @var{flags} argument is a
1327 comma separated string of flag names. The recognized names are
1328 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1329 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1330 @samp{debug}. You can set the @samp{contents} flag for a section which
1331 does not have contents, but it is not meaningful to clear the
1332 @samp{contents} flag of a section which does have contents--just remove
1333 the section instead. Not all flags are meaningful for all object file
1336 @item --add-section @var{sectionname}=@var{filename}
1337 Add a new section named @var{sectionname} while copying the file. The
1338 contents of the new section are taken from the file @var{filename}. The
1339 size of the section will be the size of the file. This option only
1340 works on file formats which can support sections with arbitrary names.
1342 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1343 Rename a section from @var{oldname} to @var{newname}, optionally
1344 changing the section's flags to @var{flags} in the process. This has
1345 the advantage over usng a linker script to perform the rename in that
1346 the output stays as an object file and does not become a linked
1349 This option is particularly helpful when the input format is binary,
1350 since this will always create a section called .data. If for example,
1351 you wanted instead to create a section called .rodata containing binary
1352 data you could use the following command line to achieve it:
1355 objcopy -I binary -O <output_format> -B <architecture> \
1356 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1357 <input_binary_file> <output_object_file>
1360 @item --long-section-names @{enable,disable,keep@}
1361 Controls the handling of long section names when processing @code{COFF}
1362 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1363 is to preserve long section names if any are present in the input file.
1364 The @samp{enable} and @samp{disable} options forcibly enable or disable
1365 the use of long section names in the output object; when @samp{disable}
1366 is in effect, any long section names in the input object will be truncated.
1367 The @samp{enable} option will only emit long section names if any are
1368 present in the inputs; this is mostly the same as @samp{keep}, but it
1369 is left undefined whether the @samp{enable} option might force the
1370 creation of an empty string table in the output file.
1372 @item --change-leading-char
1373 Some object file formats use special characters at the start of
1374 symbols. The most common such character is underscore, which compilers
1375 often add before every symbol. This option tells @command{objcopy} to
1376 change the leading character of every symbol when it converts between
1377 object file formats. If the object file formats use the same leading
1378 character, this option has no effect. Otherwise, it will add a
1379 character, or remove a character, or change a character, as
1382 @item --remove-leading-char
1383 If the first character of a global symbol is a special symbol leading
1384 character used by the object file format, remove the character. The
1385 most common symbol leading character is underscore. This option will
1386 remove a leading underscore from all global symbols. This can be useful
1387 if you want to link together objects of different file formats with
1388 different conventions for symbol names. This is different from
1389 @option{--change-leading-char} because it always changes the symbol name
1390 when appropriate, regardless of the object file format of the output
1393 @item --reverse-bytes=@var{num}
1394 Reverse the bytes in a section with output contents. A section length must
1395 be evenly divisible by the value given in order for the swap to be able to
1396 take place. Reversing takes place before the interleaving is performed.
1398 This option is used typically in generating ROM images for problematic
1399 target systems. For example, on some target boards, the 32-bit words
1400 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1401 regardless of the CPU byte order. Depending on the programming model, the
1402 endianness of the ROM may need to be modified.
1404 Consider a simple file with a section containing the following eight
1405 bytes: @code{12345678}.
1407 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1408 output file would be ordered @code{21436587}.
1410 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1411 output file would be ordered @code{43218765}.
1413 By using @samp{--reverse-bytes=2} for the above example, followed by
1414 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1415 output file would be ordered @code{34127856}.
1417 @item --srec-len=@var{ival}
1418 Meaningful only for srec output. Set the maximum length of the Srecords
1419 being produced to @var{ival}. This length covers both address, data and
1422 @item --srec-forceS3
1423 Meaningful only for srec output. Avoid generation of S1/S2 records,
1424 creating S3-only record format.
1426 @item --redefine-sym @var{old}=@var{new}
1427 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1428 when one is trying link two things together for which you have no
1429 source, and there are name collisions.
1431 @item --redefine-syms=@var{filename}
1432 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1433 listed in the file @var{filename}. @var{filename} is simply a flat file,
1434 with one symbol pair per line. Line comments may be introduced by the hash
1435 character. This option may be given more than once.
1438 Change all global symbols in the file to be weak. This can be useful
1439 when building an object which will be linked against other objects using
1440 the @option{-R} option to the linker. This option is only effective when
1441 using an object file format which supports weak symbols.
1443 @item --keep-symbols=@var{filename}
1444 Apply @option{--keep-symbol} option to each symbol listed in the file
1445 @var{filename}. @var{filename} is simply a flat file, with one symbol
1446 name per line. Line comments may be introduced by the hash character.
1447 This option may be given more than once.
1449 @item --strip-symbols=@var{filename}
1450 Apply @option{--strip-symbol} option to each symbol listed in the file
1451 @var{filename}. @var{filename} is simply a flat file, with one symbol
1452 name per line. Line comments may be introduced by the hash character.
1453 This option may be given more than once.
1455 @item --strip-unneeded-symbols=@var{filename}
1456 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1457 the file @var{filename}. @var{filename} is simply a flat file, with one
1458 symbol name per line. Line comments may be introduced by the hash
1459 character. This option may be given more than once.
1461 @item --keep-global-symbols=@var{filename}
1462 Apply @option{--keep-global-symbol} option to each symbol listed in the
1463 file @var{filename}. @var{filename} is simply a flat file, with one
1464 symbol name per line. Line comments may be introduced by the hash
1465 character. This option may be given more than once.
1467 @item --localize-symbols=@var{filename}
1468 Apply @option{--localize-symbol} option to each symbol listed in the file
1469 @var{filename}. @var{filename} is simply a flat file, with one symbol
1470 name per line. Line comments may be introduced by the hash character.
1471 This option may be given more than once.
1473 @item --globalize-symbols=@var{filename}
1474 Apply @option{--globalize-symbol} option to each symbol listed in the file
1475 @var{filename}. @var{filename} is simply a flat file, with one symbol
1476 name per line. Line comments may be introduced by the hash character.
1477 This option may be given more than once.
1479 @item --weaken-symbols=@var{filename}
1480 Apply @option{--weaken-symbol} option to each symbol listed in the file
1481 @var{filename}. @var{filename} is simply a flat file, with one symbol
1482 name per line. Line comments may be introduced by the hash character.
1483 This option may be given more than once.
1485 @item --alt-machine-code=@var{index}
1486 If the output architecture has alternate machine codes, use the
1487 @var{index}th code instead of the default one. This is useful in case
1488 a machine is assigned an official code and the tool-chain adopts the
1489 new code, but other applications still depend on the original code
1490 being used. For ELF based architectures if the @var{index}
1491 alternative does not exist then the value is treated as an absolute
1492 number to be stored in the e_machine field of the ELF header.
1494 @item --writable-text
1495 Mark the output text as writable. This option isn't meaningful for all
1496 object file formats.
1498 @item --readonly-text
1499 Make the output text write protected. This option isn't meaningful for all
1500 object file formats.
1503 Mark the output file as demand paged. This option isn't meaningful for all
1504 object file formats.
1507 Mark the output file as impure. This option isn't meaningful for all
1508 object file formats.
1510 @item --prefix-symbols=@var{string}
1511 Prefix all symbols in the output file with @var{string}.
1513 @item --prefix-sections=@var{string}
1514 Prefix all section names in the output file with @var{string}.
1516 @item --prefix-alloc-sections=@var{string}
1517 Prefix all the names of all allocated sections in the output file with
1520 @item --add-gnu-debuglink=@var{path-to-file}
1521 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1522 and adds it to the output file.
1524 @item --keep-file-symbols
1525 When stripping a file, perhaps with @option{--strip-debug} or
1526 @option{--strip-unneeded}, retain any symbols specifying source file names,
1527 which would otherwise get stripped.
1529 @item --only-keep-debug
1530 Strip a file, removing contents of any sections that would not be
1531 stripped by @option{--strip-debug} and leaving the debugging sections
1532 intact. In ELF files, this preserves all note sections in the output.
1534 The intention is that this option will be used in conjunction with
1535 @option{--add-gnu-debuglink} to create a two part executable. One a
1536 stripped binary which will occupy less space in RAM and in a
1537 distribution and the second a debugging information file which is only
1538 needed if debugging abilities are required. The suggested procedure
1539 to create these files is as follows:
1541 @item --file-alignment @var{num}
1542 Specify the file alignment. Sections in the file will always begin at
1543 file offsets which are multiples of this number. This defaults to
1545 [This option is specific to PE targets.]
1547 @item --heap @var{reserve}
1548 @itemx --heap @var{reserve},@var{commit}
1549 Specify the number of bytes of memory to reserve (and optionally commit)
1550 to be used as heap for this program.
1551 [This option is specific to PE targets.]
1553 @item --image-base @var{value}
1554 Use @var{value} as the base address of your program or dll. This is
1555 the lowest memory location that will be used when your program or dll
1556 is loaded. To reduce the need to relocate and improve performance of
1557 your dlls, each should have a unique base address and not overlap any
1558 other dlls. The default is 0x400000 for executables, and 0x10000000
1560 [This option is specific to PE targets.]
1562 @item --section-alignment @var{num}
1563 Sets the section alignment. Sections in memory will always begin at
1564 addresses which are a multiple of this number. Defaults to 0x1000.
1565 [This option is specific to PE targets.]
1567 @item --stack @var{reserve}
1568 @itemx --stack @var{reserve},@var{commit}
1569 Specify the number of bytes of memory to reserve (and optionally commit)
1570 to be used as stack for this program.
1571 [This option is specific to PE targets.]
1573 @item --subsystem @var{which}
1574 @itemx --subsystem @var{which}:@var{major}
1575 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1576 Specifies the subsystem under which your program will execute. The
1577 legal values for @var{which} are @code{native}, @code{windows},
1578 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1579 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1580 the subsystem version also. Numeric values are also accepted for
1582 [This option is specific to PE targets.]
1585 @item Link the executable as normal. Assuming that is is called
1587 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1588 create a file containing the debugging info.
1589 @item Run @code{objcopy --strip-debug foo} to create a
1590 stripped executable.
1591 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1592 to add a link to the debugging info into the stripped executable.
1595 Note---the choice of @code{.dbg} as an extension for the debug info
1596 file is arbitrary. Also the @code{--only-keep-debug} step is
1597 optional. You could instead do this:
1600 @item Link the executable as normal.
1601 @item Copy @code{foo} to @code{foo.full}
1602 @item Run @code{objcopy --strip-debug foo}
1603 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1606 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1607 full executable. It does not have to be a file created by the
1608 @option{--only-keep-debug} switch.
1610 Note---this switch is only intended for use on fully linked files. It
1611 does not make sense to use it on object files where the debugging
1612 information may be incomplete. Besides the gnu_debuglink feature
1613 currently only supports the presence of one filename containing
1614 debugging information, not multiple filenames on a one-per-object-file
1617 @item --extract-symbol
1618 Keep the file's section flags and symbols but remove all section data.
1619 Specifically, the option:
1622 @item removes the contents of all sections;
1623 @item sets the size of every section to zero; and
1624 @item sets the file's start address to zero.
1627 This option is used to build a @file{.sym} file for a VxWorks kernel.
1628 It can also be a useful way of reducing the size of a @option{--just-symbols}
1633 Show the version number of @command{objcopy}.
1637 Verbose output: list all object files modified. In the case of
1638 archives, @samp{objcopy -V} lists all members of the archive.
1641 Show a summary of the options to @command{objcopy}.
1644 Display a list showing all architectures and object formats available.
1650 @c man begin SEEALSO objcopy
1651 ld(1), objdump(1), and the Info entries for @file{binutils}.
1658 @cindex object file information
1661 @c man title objdump display information from object files.
1664 @c man begin SYNOPSIS objdump
1665 objdump [@option{-a}|@option{--archive-headers}]
1666 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1667 [@option{-C}|@option{--demangle}[=@var{style}] ]
1668 [@option{-d}|@option{--disassemble}]
1669 [@option{-D}|@option{--disassemble-all}]
1670 [@option{-z}|@option{--disassemble-zeroes}]
1671 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1672 [@option{-f}|@option{--file-headers}]
1673 [@option{-F}|@option{--file-offsets}]
1674 [@option{--file-start-context}]
1675 [@option{-g}|@option{--debugging}]
1676 [@option{-e}|@option{--debugging-tags}]
1677 [@option{-h}|@option{--section-headers}|@option{--headers}]
1678 [@option{-i}|@option{--info}]
1679 [@option{-j} @var{section}|@option{--section=}@var{section}]
1680 [@option{-l}|@option{--line-numbers}]
1681 [@option{-S}|@option{--source}]
1682 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1683 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1684 [@option{-p}|@option{--private-headers}]
1685 [@option{-r}|@option{--reloc}]
1686 [@option{-R}|@option{--dynamic-reloc}]
1687 [@option{-s}|@option{--full-contents}]
1688 [@option{-W[lLiaprmfFsoR]}|
1689 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
1690 [@option{-G}|@option{--stabs}]
1691 [@option{-t}|@option{--syms}]
1692 [@option{-T}|@option{--dynamic-syms}]
1693 [@option{-x}|@option{--all-headers}]
1694 [@option{-w}|@option{--wide}]
1695 [@option{--start-address=}@var{address}]
1696 [@option{--stop-address=}@var{address}]
1697 [@option{--prefix-addresses}]
1698 [@option{--[no-]show-raw-insn}]
1699 [@option{--adjust-vma=}@var{offset}]
1700 [@option{--special-syms}]
1701 [@option{--prefix=}@var{prefix}]
1702 [@option{--prefix-strip=}@var{level}]
1703 [@option{-V}|@option{--version}]
1704 [@option{-H}|@option{--help}]
1705 @var{objfile}@dots{}
1709 @c man begin DESCRIPTION objdump
1711 @command{objdump} displays information about one or more object files.
1712 The options control what particular information to display. This
1713 information is mostly useful to programmers who are working on the
1714 compilation tools, as opposed to programmers who just want their
1715 program to compile and work.
1717 @var{objfile}@dots{} are the object files to be examined. When you
1718 specify archives, @command{objdump} shows information on each of the member
1723 @c man begin OPTIONS objdump
1725 The long and short forms of options, shown here as alternatives, are
1726 equivalent. At least one option from the list
1727 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1731 @itemx --archive-header
1732 @cindex archive headers
1733 If any of the @var{objfile} files are archives, display the archive
1734 header information (in a format similar to @samp{ls -l}). Besides the
1735 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1736 the object file format of each archive member.
1738 @item --adjust-vma=@var{offset}
1739 @cindex section addresses in objdump
1740 @cindex VMA in objdump
1741 When dumping information, first add @var{offset} to all the section
1742 addresses. This is useful if the section addresses do not correspond to
1743 the symbol table, which can happen when putting sections at particular
1744 addresses when using a format which can not represent section addresses,
1747 @item -b @var{bfdname}
1748 @itemx --target=@var{bfdname}
1749 @cindex object code format
1750 Specify that the object-code format for the object files is
1751 @var{bfdname}. This option may not be necessary; @var{objdump} can
1752 automatically recognize many formats.
1756 objdump -b oasys -m vax -h fu.o
1759 displays summary information from the section headers (@option{-h}) of
1760 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1761 file in the format produced by Oasys compilers. You can list the
1762 formats available with the @option{-i} option.
1763 @xref{Target Selection}, for more information.
1766 @itemx --demangle[=@var{style}]
1767 @cindex demangling in objdump
1768 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1769 Besides removing any initial underscore prepended by the system, this
1770 makes C++ function names readable. Different compilers have different
1771 mangling styles. The optional demangling style argument can be used to
1772 choose an appropriate demangling style for your compiler. @xref{c++filt},
1773 for more information on demangling.
1777 Display debugging information. This attempts to parse STABS and IEEE
1778 debugging format information stored in the file and print it out using
1779 a C like syntax. If neither of these formats are found this option
1780 falls back on the @option{-W} option to print any DWARF information in
1784 @itemx --debugging-tags
1785 Like @option{-g}, but the information is generated in a format compatible
1789 @itemx --disassemble
1790 @cindex disassembling object code
1791 @cindex machine instructions
1792 Display the assembler mnemonics for the machine instructions from
1793 @var{objfile}. This option only disassembles those sections which are
1794 expected to contain instructions.
1797 @itemx --disassemble-all
1798 Like @option{-d}, but disassemble the contents of all sections, not just
1799 those expected to contain instructions.
1801 @item --prefix-addresses
1802 When disassembling, print the complete address on each line. This is
1803 the older disassembly format.
1807 @itemx --endian=@{big|little@}
1809 @cindex disassembly endianness
1810 Specify the endianness of the object files. This only affects
1811 disassembly. This can be useful when disassembling a file format which
1812 does not describe endianness information, such as S-records.
1815 @itemx --file-headers
1816 @cindex object file header
1817 Display summary information from the overall header of
1818 each of the @var{objfile} files.
1821 @itemx --file-offsets
1822 @cindex object file offsets
1823 When disassembling sections, whenever a symbol is displayed, also
1824 display the file offset of the region of data that is about to be
1825 dumped. If zeroes are being skipped, then when disassembly resumes,
1826 tell the user how many zeroes were skipped and the file offset of the
1827 location from where the disassembly resumes. When dumping sections,
1828 display the file offset of the location from where the dump starts.
1830 @item --file-start-context
1831 @cindex source code context
1832 Specify that when displaying interlisted source code/disassembly
1833 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1834 context to the start of the file.
1837 @itemx --section-headers
1839 @cindex section headers
1840 Display summary information from the section headers of the
1843 File segments may be relocated to nonstandard addresses, for example by
1844 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1845 @command{ld}. However, some object file formats, such as a.out, do not
1846 store the starting address of the file segments. In those situations,
1847 although @command{ld} relocates the sections correctly, using @samp{objdump
1848 -h} to list the file section headers cannot show the correct addresses.
1849 Instead, it shows the usual addresses, which are implicit for the
1854 Print a summary of the options to @command{objdump} and exit.
1858 @cindex architectures available
1859 @cindex object formats available
1860 Display a list showing all architectures and object formats available
1861 for specification with @option{-b} or @option{-m}.
1864 @itemx --section=@var{name}
1865 @cindex section information
1866 Display information only for section @var{name}.
1869 @itemx --line-numbers
1870 @cindex source filenames for object files
1871 Label the display (using debugging information) with the filename and
1872 source line numbers corresponding to the object code or relocs shown.
1873 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1875 @item -m @var{machine}
1876 @itemx --architecture=@var{machine}
1877 @cindex architecture
1878 @cindex disassembly architecture
1879 Specify the architecture to use when disassembling object files. This
1880 can be useful when disassembling object files which do not describe
1881 architecture information, such as S-records. You can list the available
1882 architectures with the @option{-i} option.
1884 @item -M @var{options}
1885 @itemx --disassembler-options=@var{options}
1886 Pass target specific information to the disassembler. Only supported on
1887 some targets. If it is necessary to specify more than one
1888 disassembler option then multiple @option{-M} options can be used or
1889 can be placed together into a comma separated list.
1891 If the target is an ARM architecture then this switch can be used to
1892 select which register name set is used during disassembler. Specifying
1893 @option{-M reg-names-std} (the default) will select the register names as
1894 used in ARM's instruction set documentation, but with register 13 called
1895 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1896 @option{-M reg-names-apcs} will select the name set used by the ARM
1897 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1898 just use @samp{r} followed by the register number.
1900 There are also two variants on the APCS register naming scheme enabled
1901 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1902 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1903 with the normal register names or the special register names).
1905 This option can also be used for ARM architectures to force the
1906 disassembler to interpret all instructions as Thumb instructions by
1907 using the switch @option{--disassembler-options=force-thumb}. This can be
1908 useful when attempting to disassemble thumb code produced by other
1911 For the x86, some of the options duplicate functions of the @option{-m}
1912 switch, but allow finer grained control. Multiple selections from the
1913 following may be specified as a comma separated string.
1914 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
1915 the given architecture. @option{intel} and @option{att} select between
1916 intel syntax mode and AT&T syntax mode.
1917 @option{intel-mnemonic} and @option{att-mnemonic} select between
1918 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
1919 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
1920 @option{addr64}, @option{addr32},
1921 @option{addr16}, @option{data32} and @option{data16} specify the default
1922 address size and operand size. These four options will be overridden if
1923 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
1924 option string. Lastly, @option{suffix}, when in AT&T mode,
1925 instructs the disassembler to print a mnemonic suffix even when the
1926 suffix could be inferred by the operands.
1928 For PowerPC, @option{booke} controls the disassembly of BookE
1929 instructions. @option{32} and @option{64} select PowerPC and
1930 PowerPC64 disassembly, respectively. @option{e300} selects
1931 disassembly for the e300 family. @option{440} selects disassembly for
1932 the PowerPC 440. @option{ppcps} selects disassembly for the paired
1933 single instructions of the PPC750CL.
1935 For MIPS, this option controls the printing of instruction mnemonic
1936 names and register names in disassembled instructions. Multiple
1937 selections from the following may be specified as a comma separated
1938 string, and invalid options are ignored:
1942 Print the 'raw' instruction mnemonic instead of some pseudo
1943 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
1944 'sll' instead of 'nop', etc.
1946 @item gpr-names=@var{ABI}
1947 Print GPR (general-purpose register) names as appropriate
1948 for the specified ABI. By default, GPR names are selected according to
1949 the ABI of the binary being disassembled.
1951 @item fpr-names=@var{ABI}
1952 Print FPR (floating-point register) names as
1953 appropriate for the specified ABI. By default, FPR numbers are printed
1956 @item cp0-names=@var{ARCH}
1957 Print CP0 (system control coprocessor; coprocessor 0) register names
1958 as appropriate for the CPU or architecture specified by
1959 @var{ARCH}. By default, CP0 register names are selected according to
1960 the architecture and CPU of the binary being disassembled.
1962 @item hwr-names=@var{ARCH}
1963 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1964 as appropriate for the CPU or architecture specified by
1965 @var{ARCH}. By default, HWR names are selected according to
1966 the architecture and CPU of the binary being disassembled.
1968 @item reg-names=@var{ABI}
1969 Print GPR and FPR names as appropriate for the selected ABI.
1971 @item reg-names=@var{ARCH}
1972 Print CPU-specific register names (CP0 register and HWR names)
1973 as appropriate for the selected CPU or architecture.
1976 For any of the options listed above, @var{ABI} or
1977 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
1978 rather than names, for the selected types of registers.
1979 You can list the available values of @var{ABI} and @var{ARCH} using
1980 the @option{--help} option.
1982 For VAX, you can specify function entry addresses with @option{-M
1983 entry:0xf00ba}. You can use this multiple times to properly
1984 disassemble VAX binary files that don't contain symbol tables (like
1985 ROM dumps). In these cases, the function entry mask would otherwise
1986 be decoded as VAX instructions, which would probably lead the rest
1987 of the function being wrongly disassembled.
1990 @itemx --private-headers
1991 Print information that is specific to the object file format. The exact
1992 information printed depends upon the object file format. For some
1993 object file formats, no additional information is printed.
1997 @cindex relocation entries, in object file
1998 Print the relocation entries of the file. If used with @option{-d} or
1999 @option{-D}, the relocations are printed interspersed with the
2003 @itemx --dynamic-reloc
2004 @cindex dynamic relocation entries, in object file
2005 Print the dynamic relocation entries of the file. This is only
2006 meaningful for dynamic objects, such as certain types of shared
2007 libraries. As for @option{-r}, if used with @option{-d} or
2008 @option{-D}, the relocations are printed interspersed with the
2012 @itemx --full-contents
2013 @cindex sections, full contents
2014 @cindex object file sections
2015 Display the full contents of any sections requested. By default all
2016 non-empty sections are displayed.
2020 @cindex source disassembly
2021 @cindex disassembly, with source
2022 Display source code intermixed with disassembly, if possible. Implies
2025 @item --prefix=@var{prefix}
2026 @cindex Add prefix to absolute paths
2027 Specify @var{prefix} to add to the absolute paths when used with
2030 @item --prefix-strip=@var{level}
2031 @cindex Strip absolute paths
2032 Indicate how many initial directory names to strip off the hardwired
2033 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2035 @item --show-raw-insn
2036 When disassembling instructions, print the instruction in hex as well as
2037 in symbolic form. This is the default except when
2038 @option{--prefix-addresses} is used.
2040 @item --no-show-raw-insn
2041 When disassembling instructions, do not print the instruction bytes.
2042 This is the default when @option{--prefix-addresses} is used.
2044 @item -W[lLiaprmfFsoR]
2045 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
2047 @cindex debug symbols
2048 Displays the contents of the debug sections in the file, if any are
2049 present. If one of the optional letters or words follows the switch
2050 then only data found in those specific sections will be dumped.
2056 @cindex debug symbols
2057 @cindex ELF object file format
2058 Display the full contents of any sections requested. Display the
2059 contents of the .stab and .stab.index and .stab.excl sections from an
2060 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2061 @code{.stab} debugging symbol-table entries are carried in an ELF
2062 section. In most other file formats, debugging symbol-table entries are
2063 interleaved with linkage symbols, and are visible in the @option{--syms}
2066 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
2067 Overview,stabs.info, The ``stabs'' debug format}.
2070 @item --start-address=@var{address}
2071 @cindex start-address
2072 Start displaying data at the specified address. This affects the output
2073 of the @option{-d}, @option{-r} and @option{-s} options.
2075 @item --stop-address=@var{address}
2076 @cindex stop-address
2077 Stop displaying data at the specified address. This affects the output
2078 of the @option{-d}, @option{-r} and @option{-s} options.
2082 @cindex symbol table entries, printing
2083 Print the symbol table entries of the file.
2084 This is similar to the information provided by the @samp{nm} program,
2085 although the display format is different. The format of the output
2086 depends upon the format of the file being dumped, but there are two main
2087 types. One looks like this:
2090 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2091 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2094 where the number inside the square brackets is the number of the entry
2095 in the symbol table, the @var{sec} number is the section number, the
2096 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2097 symbol's type, the @var{scl} number is the symbol's storage class and
2098 the @var{nx} value is the number of auxilary entries associated with
2099 the symbol. The last two fields are the symbol's value and its name.
2101 The other common output format, usually seen with ELF based files,
2105 00000000 l d .bss 00000000 .bss
2106 00000000 g .text 00000000 fred
2109 Here the first number is the symbol's value (sometimes refered to as
2110 its address). The next field is actually a set of characters and
2111 spaces indicating the flag bits that are set on the symbol. These
2112 characters are described below. Next is the section with which the
2113 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2114 not connected with any section), or @emph{*UND*} if the section is
2115 referenced in the file being dumped, but not defined there.
2117 After the section name comes another field, a number, which for common
2118 symbols is the alignment and for other symbol is the size. Finally
2119 the symbol's name is displayed.
2121 The flag characters are divided into 7 groups as follows:
2126 The symbol is local (l), global (g), neither (a space) or both (!). A
2127 symbol can be neither local or global for a variety of reasons, e.g.,
2128 because it is used for debugging, but it is probably an indication of
2129 a bug if it is ever both local and global.
2132 The symbol is weak (w) or strong (a space).
2135 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2138 The symbol is a warning (W) or a normal symbol (a space). A warning
2139 symbol's name is a message to be displayed if the symbol following the
2140 warning symbol is ever referenced.
2144 The symbol is an indirect reference to another symbol (I), a function
2145 to be evaluated during reloc processing (i) or a normal symbol (a
2150 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2151 normal symbol (a space).
2156 The symbol is the name of a function (F) or a file (f) or an object
2157 (O) or just a normal symbol (a space).
2161 @itemx --dynamic-syms
2162 @cindex dynamic symbol table entries, printing
2163 Print the dynamic symbol table entries of the file. This is only
2164 meaningful for dynamic objects, such as certain types of shared
2165 libraries. This is similar to the information provided by the @samp{nm}
2166 program when given the @option{-D} (@option{--dynamic}) option.
2168 @item --special-syms
2169 When displaying symbols include those which the target considers to be
2170 special in some way and which would not normally be of interest to the
2175 Print the version number of @command{objdump} and exit.
2178 @itemx --all-headers
2179 @cindex all header information, object file
2180 @cindex header information, all
2181 Display all available header information, including the symbol table and
2182 relocation entries. Using @option{-x} is equivalent to specifying all of
2183 @option{-a -f -h -p -r -t}.
2187 @cindex wide output, printing
2188 Format some lines for output devices that have more than 80 columns.
2189 Also do not truncate symbol names when they are displayed.
2192 @itemx --disassemble-zeroes
2193 Normally the disassembly output will skip blocks of zeroes. This
2194 option directs the disassembler to disassemble those blocks, just like
2201 @c man begin SEEALSO objdump
2202 nm(1), readelf(1), and the Info entries for @file{binutils}.
2210 @cindex archive contents
2211 @cindex symbol index
2213 @c man title ranlib generate index to archive.
2216 @c man begin SYNOPSIS ranlib
2217 ranlib [@option{-vVt}] @var{archive}
2221 @c man begin DESCRIPTION ranlib
2223 @command{ranlib} generates an index to the contents of an archive and
2224 stores it in the archive. The index lists each symbol defined by a
2225 member of an archive that is a relocatable object file.
2227 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2229 An archive with such an index speeds up linking to the library and
2230 allows routines in the library to call each other without regard to
2231 their placement in the archive.
2233 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2234 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2239 @c man begin OPTIONS ranlib
2245 Show the version number of @command{ranlib}.
2248 Update the timestamp of the symbol map of an archive.
2254 @c man begin SEEALSO ranlib
2255 ar(1), nm(1), and the Info entries for @file{binutils}.
2263 @cindex section sizes
2265 @c man title size list section sizes and total size.
2268 @c man begin SYNOPSIS size
2269 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2271 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2273 [@option{-t}|@option{--totals}]
2274 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2275 [@var{objfile}@dots{}]
2279 @c man begin DESCRIPTION size
2281 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2282 size---for each of the object or archive files @var{objfile} in its
2283 argument list. By default, one line of output is generated for each
2284 object file or each module in an archive.
2286 @var{objfile}@dots{} are the object files to be examined.
2287 If none are specified, the file @code{a.out} will be used.
2291 @c man begin OPTIONS size
2293 The command line options have the following meanings:
2298 @itemx --format=@var{compatibility}
2299 @cindex @command{size} display format
2300 Using one of these options, you can choose whether the output from @sc{gnu}
2301 @command{size} resembles output from System V @command{size} (using @option{-A},
2302 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2303 @option{--format=berkeley}). The default is the one-line format similar to
2305 @c Bonus for doc-source readers: you can also say --format=strange (or
2306 @c anything else that starts with 's') for sysv, and --format=boring (or
2307 @c anything else that starts with 'b') for Berkeley.
2309 Here is an example of the Berkeley (default) format of output from
2312 $ size --format=Berkeley ranlib size
2313 text data bss dec hex filename
2314 294880 81920 11592 388392 5ed28 ranlib
2315 294880 81920 11888 388688 5ee50 size
2319 This is the same data, but displayed closer to System V conventions:
2322 $ size --format=SysV ranlib size
2340 Show a summary of acceptable arguments and options.
2345 @itemx --radix=@var{number}
2346 @cindex @command{size} number format
2347 @cindex radix for section sizes
2348 Using one of these options, you can control whether the size of each
2349 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2350 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2351 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2352 values (8, 10, 16) are supported. The total size is always given in two
2353 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2354 octal and hexadecimal if you're using @option{-o}.
2357 Print total size of common symbols in each file. When using Berkeley
2358 format these are included in the bss size.
2362 Show totals of all objects listed (Berkeley format listing mode only).
2364 @item --target=@var{bfdname}
2365 @cindex object code format
2366 Specify that the object-code format for @var{objfile} is
2367 @var{bfdname}. This option may not be necessary; @command{size} can
2368 automatically recognize many formats.
2369 @xref{Target Selection}, for more information.
2373 Display the version number of @command{size}.
2379 @c man begin SEEALSO size
2380 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2387 @cindex listings strings
2388 @cindex printing strings
2389 @cindex strings, printing
2391 @c man title strings print the strings of printable characters in files.
2394 @c man begin SYNOPSIS strings
2395 strings [@option{-afovV}] [@option{-}@var{min-len}]
2396 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2397 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2398 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2399 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2400 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2401 [@option{--help}] [@option{--version}] @var{file}@dots{}
2405 @c man begin DESCRIPTION strings
2407 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2408 character sequences that are at least 4 characters long (or the number
2409 given with the options below) and are followed by an unprintable
2410 character. By default, it only prints the strings from the initialized
2411 and loaded sections of object files; for other types of files, it prints
2412 the strings from the whole file.
2414 @command{strings} is mainly useful for determining the contents of non-text
2419 @c man begin OPTIONS strings
2425 Do not scan only the initialized and loaded sections of object files;
2426 scan the whole files.
2429 @itemx --print-file-name
2430 Print the name of the file before each string.
2433 Print a summary of the program usage on the standard output and exit.
2435 @item -@var{min-len}
2436 @itemx -n @var{min-len}
2437 @itemx --bytes=@var{min-len}
2438 Print sequences of characters that are at least @var{min-len} characters
2439 long, instead of the default 4.
2442 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2443 act like @samp{-t d} instead. Since we can not be compatible with both
2444 ways, we simply chose one.
2446 @item -t @var{radix}
2447 @itemx --radix=@var{radix}
2448 Print the offset within the file before each string. The single
2449 character argument specifies the radix of the offset---@samp{o} for
2450 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2452 @item -e @var{encoding}
2453 @itemx --encoding=@var{encoding}
2454 Select the character encoding of the strings that are to be found.
2455 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2456 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2457 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2458 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2459 littleendian. Useful for finding wide character strings. (@samp{l}
2460 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2462 @item -T @var{bfdname}
2463 @itemx --target=@var{bfdname}
2464 @cindex object code format
2465 Specify an object code format other than your system's default format.
2466 @xref{Target Selection}, for more information.
2471 Print the program version number on the standard output and exit.
2477 @c man begin SEEALSO strings
2478 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2479 and the Info entries for @file{binutils}.
2487 @cindex removing symbols
2488 @cindex discarding symbols
2489 @cindex symbols, discarding
2491 @c man title strip Discard symbols from object files.
2494 @c man begin SYNOPSIS strip
2495 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2496 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2497 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2498 [@option{-s}|@option{--strip-all}]
2499 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2500 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2501 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2502 [@option{-w}|@option{--wildcard}]
2503 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2504 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2505 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2506 [@option{--keep-file-symbols}]
2507 [@option{--only-keep-debug}]
2508 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2509 [@option{--help}] [@option{--info}]
2510 @var{objfile}@dots{}
2514 @c man begin DESCRIPTION strip
2516 @sc{gnu} @command{strip} discards all symbols from object files
2517 @var{objfile}. The list of object files may include archives.
2518 At least one object file must be given.
2520 @command{strip} modifies the files named in its argument,
2521 rather than writing modified copies under different names.
2525 @c man begin OPTIONS strip
2528 @item -F @var{bfdname}
2529 @itemx --target=@var{bfdname}
2530 Treat the original @var{objfile} as a file with the object
2531 code format @var{bfdname}, and rewrite it in the same format.
2532 @xref{Target Selection}, for more information.
2535 Show a summary of the options to @command{strip} and exit.
2538 Display a list showing all architectures and object formats available.
2540 @item -I @var{bfdname}
2541 @itemx --input-target=@var{bfdname}
2542 Treat the original @var{objfile} as a file with the object
2543 code format @var{bfdname}.
2544 @xref{Target Selection}, for more information.
2546 @item -O @var{bfdname}
2547 @itemx --output-target=@var{bfdname}
2548 Replace @var{objfile} with a file in the output format @var{bfdname}.
2549 @xref{Target Selection}, for more information.
2551 @item -R @var{sectionname}
2552 @itemx --remove-section=@var{sectionname}
2553 Remove any section named @var{sectionname} from the output file. This
2554 option may be given more than once. Note that using this option
2555 inappropriately may make the output file unusable.
2564 @itemx --strip-debug
2565 Remove debugging symbols only.
2567 @item --strip-unneeded
2568 Remove all symbols that are not needed for relocation processing.
2570 @item -K @var{symbolname}
2571 @itemx --keep-symbol=@var{symbolname}
2572 When stripping symbols, keep symbol @var{symbolname} even if it would
2573 normally be stripped. This option may be given more than once.
2575 @item -N @var{symbolname}
2576 @itemx --strip-symbol=@var{symbolname}
2577 Remove symbol @var{symbolname} from the source file. This option may be
2578 given more than once, and may be combined with strip options other than
2582 Put the stripped output in @var{file}, rather than replacing the
2583 existing file. When this argument is used, only one @var{objfile}
2584 argument may be specified.
2587 @itemx --preserve-dates
2588 Preserve the access and modification dates of the file.
2592 Permit regular expressions in @var{symbolname}s used in other command
2593 line options. The question mark (?), asterisk (*), backslash (\) and
2594 square brackets ([]) operators can be used anywhere in the symbol
2595 name. If the first character of the symbol name is the exclamation
2596 point (!) then the sense of the switch is reversed for that symbol.
2603 would cause strip to only keep symbols that start with the letters
2604 ``fo'', but to discard the symbol ``foo''.
2607 @itemx --discard-all
2608 Remove non-global symbols.
2611 @itemx --discard-locals
2612 Remove compiler-generated local symbols.
2613 (These usually start with @samp{L} or @samp{.}.)
2615 @item --keep-file-symbols
2616 When stripping a file, perhaps with @option{--strip-debug} or
2617 @option{--strip-unneeded}, retain any symbols specifying source file names,
2618 which would otherwise get stripped.
2620 @item --only-keep-debug
2621 Strip a file, removing contents of any sections that would not be
2622 stripped by @option{--strip-debug} and leaving the debugging sections
2623 intact. In ELF files, this preserves all note sections in the output.
2625 The intention is that this option will be used in conjunction with
2626 @option{--add-gnu-debuglink} to create a two part executable. One a
2627 stripped binary which will occupy less space in RAM and in a
2628 distribution and the second a debugging information file which is only
2629 needed if debugging abilities are required. The suggested procedure
2630 to create these files is as follows:
2633 @item Link the executable as normal. Assuming that is is called
2635 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2636 create a file containing the debugging info.
2637 @item Run @code{objcopy --strip-debug foo} to create a
2638 stripped executable.
2639 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2640 to add a link to the debugging info into the stripped executable.
2643 Note---the choice of @code{.dbg} as an extension for the debug info
2644 file is arbitrary. Also the @code{--only-keep-debug} step is
2645 optional. You could instead do this:
2648 @item Link the executable as normal.
2649 @item Copy @code{foo} to @code{foo.full}
2650 @item Run @code{strip --strip-debug foo}
2651 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2654 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2655 full executable. It does not have to be a file created by the
2656 @option{--only-keep-debug} switch.
2658 Note---this switch is only intended for use on fully linked files. It
2659 does not make sense to use it on object files where the debugging
2660 information may be incomplete. Besides the gnu_debuglink feature
2661 currently only supports the presence of one filename containing
2662 debugging information, not multiple filenames on a one-per-object-file
2667 Show the version number for @command{strip}.
2671 Verbose output: list all object files modified. In the case of
2672 archives, @samp{strip -v} lists all members of the archive.
2678 @c man begin SEEALSO strip
2679 the Info entries for @file{binutils}.
2683 @node c++filt, addr2line, strip, Top
2687 @cindex demangling C++ symbols
2689 @c man title cxxfilt Demangle C++ and Java symbols.
2692 @c man begin SYNOPSIS cxxfilt
2693 c++filt [@option{-_}|@option{--strip-underscores}]
2694 [@option{-n}|@option{--no-strip-underscores}]
2695 [@option{-p}|@option{--no-params}]
2696 [@option{-t}|@option{--types}]
2697 [@option{-i}|@option{--no-verbose}]
2698 [@option{-s} @var{format}|@option{--format=}@var{format}]
2699 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2703 @c man begin DESCRIPTION cxxfilt
2706 The C++ and Java languages provide function overloading, which means
2707 that you can write many functions with the same name, providing that
2708 each function takes parameters of different types. In order to be
2709 able to distinguish these similarly named functions C++ and Java
2710 encode them into a low-level assembler name which uniquely identifies
2711 each different version. This process is known as @dfn{mangling}. The
2713 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2714 MS-DOS this program is named @command{CXXFILT}.}
2715 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2716 names into user-level names so that they can be read.
2718 Every alphanumeric word (consisting of letters, digits, underscores,
2719 dollars, or periods) seen in the input is a potential mangled name.
2720 If the name decodes into a C++ name, the C++ name replaces the
2721 low-level name in the output, otherwise the original word is output.
2722 In this way you can pass an entire assembler source file, containing
2723 mangled names, through @command{c++filt} and see the same source file
2724 containing demangled names.
2726 You can also use @command{c++filt} to decipher individual symbols by
2727 passing them on the command line:
2730 c++filt @var{symbol}
2733 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2734 names from the standard input instead. All the results are printed on
2735 the standard output. The difference between reading names from the
2736 command line versus reading names from the standard input is that
2737 command line arguments are expected to be just mangled names and no
2738 checking is performed to separate them from surrounding text. Thus
2745 will work and demangle the name to ``f()'' whereas:
2751 will not work. (Note the extra comma at the end of the mangled
2752 name which makes it invalid). This command however will work:
2755 echo _Z1fv, | c++filt -n
2758 and will display ``f(),'', i.e., the demangled name followed by a
2759 trailing comma. This behaviour is because when the names are read
2760 from the standard input it is expected that they might be part of an
2761 assembler source file where there might be extra, extraneous
2762 characters trailing after a mangled name. For example:
2765 .type _Z1fv, @@function
2770 @c man begin OPTIONS cxxfilt
2774 @itemx --strip-underscores
2775 On some systems, both the C and C++ compilers put an underscore in front
2776 of every name. For example, the C name @code{foo} gets the low-level
2777 name @code{_foo}. This option removes the initial underscore. Whether
2778 @command{c++filt} removes the underscore by default is target dependent.
2782 Prints demangled names using Java syntax. The default is to use C++
2786 @itemx --no-strip-underscores
2787 Do not remove the initial underscore.
2791 When demangling the name of a function, do not display the types of
2792 the function's parameters.
2796 Attempt to demangle types as well as function names. This is disabled
2797 by default since mangled types are normally only used internally in
2798 the compiler, and they can be confused with non-mangled names. For example,
2799 a function called ``a'' treated as a mangled type name would be
2800 demangled to ``signed char''.
2804 Do not include implementation details (if any) in the demangled
2807 @item -s @var{format}
2808 @itemx --format=@var{format}
2809 @command{c++filt} can decode various methods of mangling, used by
2810 different compilers. The argument to this option selects which
2815 Automatic selection based on executable (the default method)
2817 the one used by the @sc{gnu} C++ compiler (g++)
2819 the one used by the Lucid compiler (lcc)
2821 the one specified by the C++ Annotated Reference Manual
2823 the one used by the HP compiler (aCC)
2825 the one used by the EDG compiler
2827 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2829 the one used by the @sc{gnu} Java compiler (gcj)
2831 the one used by the @sc{gnu} Ada compiler (GNAT).
2835 Print a summary of the options to @command{c++filt} and exit.
2838 Print the version number of @command{c++filt} and exit.
2844 @c man begin SEEALSO cxxfilt
2845 the Info entries for @file{binutils}.
2850 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2851 user interface are subject to change in future releases. In particular,
2852 a command-line option may be required in the future to decode a name
2853 passed as an argument on the command line; in other words,
2856 c++filt @var{symbol}
2860 may in a future release become
2863 c++filt @var{option} @var{symbol}
2871 @cindex address to file name and line number
2873 @c man title addr2line convert addresses into file names and line numbers.
2876 @c man begin SYNOPSIS addr2line
2877 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2878 [@option{-C}|@option{--demangle}[=@var{style}]]
2879 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2880 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2881 [@option{-i}|@option{--inlines}]
2882 [@option{-j}|@option{--section=}@var{name}]
2883 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2888 @c man begin DESCRIPTION addr2line
2890 @command{addr2line} translates addresses into file names and line numbers.
2891 Given an address in an executable or an offset in a section of a relocatable
2892 object, it uses the debugging information to figure out which file name and
2893 line number are associated with it.
2895 The executable or relocatable object to use is specified with the @option{-e}
2896 option. The default is the file @file{a.out}. The section in the relocatable
2897 object to use is specified with the @option{-j} option.
2899 @command{addr2line} has two modes of operation.
2901 In the first, hexadecimal addresses are specified on the command line,
2902 and @command{addr2line} displays the file name and line number for each
2905 In the second, @command{addr2line} reads hexadecimal addresses from
2906 standard input, and prints the file name and line number for each
2907 address on standard output. In this mode, @command{addr2line} may be used
2908 in a pipe to convert dynamically chosen addresses.
2910 The format of the output is @samp{FILENAME:LINENO}. The file name and
2911 line number for each address is printed on a separate line. If the
2912 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2913 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2914 containing the address.
2916 If the file name or function name can not be determined,
2917 @command{addr2line} will print two question marks in their place. If the
2918 line number can not be determined, @command{addr2line} will print 0.
2922 @c man begin OPTIONS addr2line
2924 The long and short forms of options, shown here as alternatives, are
2928 @item -b @var{bfdname}
2929 @itemx --target=@var{bfdname}
2930 @cindex object code format
2931 Specify that the object-code format for the object files is
2935 @itemx --demangle[=@var{style}]
2936 @cindex demangling in objdump
2937 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2938 Besides removing any initial underscore prepended by the system, this
2939 makes C++ function names readable. Different compilers have different
2940 mangling styles. The optional demangling style argument can be used to
2941 choose an appropriate demangling style for your compiler. @xref{c++filt},
2942 for more information on demangling.
2944 @item -e @var{filename}
2945 @itemx --exe=@var{filename}
2946 Specify the name of the executable for which addresses should be
2947 translated. The default file is @file{a.out}.
2951 Display function names as well as file and line number information.
2955 Display only the base of each file name.
2959 If the address belongs to a function that was inlined, the source
2960 information for all enclosing scopes back to the first non-inlined
2961 function will also be printed. For example, if @code{main} inlines
2962 @code{callee1} which inlines @code{callee2}, and address is from
2963 @code{callee2}, the source information for @code{callee1} and @code{main}
2964 will also be printed.
2968 Read offsets relative to the specified section instead of absolute addresses.
2974 @c man begin SEEALSO addr2line
2975 Info entries for @file{binutils}.
2982 @command{nlmconv} converts a relocatable object file into a NetWare
2986 @command{nlmconv} currently works with @samp{i386} object
2987 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2988 object files in @sc{elf}, or @code{a.out} format@footnote{
2989 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2990 format in the Binary File Descriptor library. It has only been tested
2991 with the above formats.}.
2995 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2996 utilities, since it is only useful for NLM targets.
2999 @c man title nlmconv converts object code into an NLM.
3002 @c man begin SYNOPSIS nlmconv
3003 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3004 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3005 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3006 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3007 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3008 @var{infile} @var{outfile}
3012 @c man begin DESCRIPTION nlmconv
3014 @command{nlmconv} converts the relocatable @samp{i386} object file
3015 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3016 reading @var{headerfile} for NLM header information. For instructions
3017 on writing the NLM command file language used in header files, see the
3018 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3019 Development and Tools Overview}, which is part of the NLM Software
3020 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3021 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3024 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3027 @command{nlmconv} can perform a link step. In other words, you can list
3028 more than one object file for input if you list them in the definitions
3029 file (rather than simply specifying one input file on the command line).
3030 In this case, @command{nlmconv} calls the linker for you.
3034 @c man begin OPTIONS nlmconv
3037 @item -I @var{bfdname}
3038 @itemx --input-target=@var{bfdname}
3039 Object format of the input file. @command{nlmconv} can usually determine
3040 the format of a given file (so no default is necessary).
3041 @xref{Target Selection}, for more information.
3043 @item -O @var{bfdname}
3044 @itemx --output-target=@var{bfdname}
3045 Object format of the output file. @command{nlmconv} infers the output
3046 format based on the input format, e.g. for a @samp{i386} input file the
3047 output format is @samp{nlm32-i386}.
3048 @xref{Target Selection}, for more information.
3050 @item -T @var{headerfile}
3051 @itemx --header-file=@var{headerfile}
3052 Reads @var{headerfile} for NLM header information. For instructions on
3053 writing the NLM command file language used in header files, see@ see the
3054 @samp{linkers} section, of the @cite{NLM Development and Tools
3055 Overview}, which is part of the NLM Software Developer's Kit, available
3060 Displays (on standard error) the linker command line used by @command{nlmconv}.
3062 @item -l @var{linker}
3063 @itemx --linker=@var{linker}
3064 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3069 Prints a usage summary.
3073 Prints the version number for @command{nlmconv}.
3079 @c man begin SEEALSO nlmconv
3080 the Info entries for @file{binutils}.
3087 @command{windmc} may be used to generator Windows message resources.
3090 @emph{Warning:} @command{windmc} is not always built as part of the binary
3091 utilities, since it is only useful for Windows targets.
3094 @c man title windmc generates Windows message resources.
3097 @c man begin SYNOPSIS windres
3098 windmc [options] input-file
3102 @c man begin DESCRIPTION windmc
3104 @command{windmc} reads message definitions from an input file (.mc) and
3105 translate them into a set of output files. The output files may be of
3110 A C header file containing the message definitions.
3113 A resource file compilable by the @command{windres} tool.
3116 One or more binary files containing the resource data for a specific
3120 A C include file that maps message id's to their symbolic name.
3123 The exact description of these different formats is available in
3124 documentation from Microsoft.
3126 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3127 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3128 Windows Message Compiler.
3132 @c man begin OPTIONS windmc
3137 Specifies that the input file specified is ANSI. This is the default
3142 Specifies that messages in the output @code{bin} files should be in ANSI
3147 Specifies that @code{bin} filenames should have to be prefixed by the
3148 basename of the source file.
3152 Sets the customer bit in all message id's.
3154 @item -C @var{codepage}
3155 @itemx --codepage_in @var{codepage}
3156 Sets the default codepage to be used to convert input file to UTF16. The
3157 default is ocdepage 1252.
3160 @itemx --decimal_values
3161 Outputs the constants in the header file in decimal. Default is using
3165 @itemx --extension @var{ext}
3166 The extension for the header file. The default is .h extension.
3168 @item -F @var{target}
3169 @itemx --target @var{target}
3170 Specify the BFD format to use for a bin file as output. This
3171 is a BFD target name; you can use the @option{--help} option to see a list
3172 of supported targets. Normally @command{windmc} will use the default
3173 format, which is the first one listed by the @option{--help} option.
3175 @ref{Target Selection}.
3179 @itemx --headerdir @var{path}
3180 The target directory of the generated header file. The default is the
3185 Displays a list of command line options and then exits.
3187 @item -m @var{characters}
3188 @itemx --maxlength @var{characters}
3189 Instructs @command{windmc} to generate a warning if the length
3190 of any message exceeds the number specified.
3193 @itemx --nullterminate
3194 Terminate message text in @code{bin} files by zero. By default they are
3195 terminated by CR/LF.
3198 @itemx --hresult_use
3199 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3200 file, using HRESULT definitions. Status codes are used if the flag is not
3203 @item -O @var{codepage}
3204 @itemx --codepage_out @var{codepage}
3205 Sets the default codepage to be used to output text files. The default
3209 @itemx --rcdir @var{path}
3210 The target directory for the generated @code{rc} script and the generated
3211 @code{bin} files that the resource compiler script includes. The default
3212 is the current directory.
3216 Specifies that the input file is UTF16.
3219 @itemx --unicode_out
3220 Specifies that messages in the output @code{bin} file should be in UTF16
3221 format. This is the default behaviour.
3225 Enable verbose mode.
3229 Prints the version number for @command{windmc}.
3232 @itemx --xdgb @var{path}
3233 The path of the @code{dbg} C include file that maps message id's to the
3234 symbolic name. No such file is generated without specifying the switch.
3240 @c man begin SEEALSO windmc
3241 the Info entries for @file{binutils}.
3248 @command{windres} may be used to manipulate Windows resources.
3251 @emph{Warning:} @command{windres} is not always built as part of the binary
3252 utilities, since it is only useful for Windows targets.
3255 @c man title windres manipulate Windows resources.
3258 @c man begin SYNOPSIS windres
3259 windres [options] [input-file] [output-file]
3263 @c man begin DESCRIPTION windres
3265 @command{windres} reads resources from an input file and copies them into
3266 an output file. Either file may be in one of three formats:
3270 A text format read by the Resource Compiler.
3273 A binary format generated by the Resource Compiler.
3276 A COFF object or executable.
3279 The exact description of these different formats is available in
3280 documentation from Microsoft.
3282 When @command{windres} converts from the @code{rc} format to the @code{res}
3283 format, it is acting like the Windows Resource Compiler. When
3284 @command{windres} converts from the @code{res} format to the @code{coff}
3285 format, it is acting like the Windows @code{CVTRES} program.
3287 When @command{windres} generates an @code{rc} file, the output is similar
3288 but not identical to the format expected for the input. When an input
3289 @code{rc} file refers to an external filename, an output @code{rc} file
3290 will instead include the file contents.
3292 If the input or output format is not specified, @command{windres} will
3293 guess based on the file name, or, for the input file, the file contents.
3294 A file with an extension of @file{.rc} will be treated as an @code{rc}
3295 file, a file with an extension of @file{.res} will be treated as a
3296 @code{res} file, and a file with an extension of @file{.o} or
3297 @file{.exe} will be treated as a @code{coff} file.
3299 If no output file is specified, @command{windres} will print the resources
3300 in @code{rc} format to standard output.
3302 The normal use is for you to write an @code{rc} file, use @command{windres}
3303 to convert it to a COFF object file, and then link the COFF file into
3304 your application. This will make the resources described in the
3305 @code{rc} file available to Windows.
3309 @c man begin OPTIONS windres
3312 @item -i @var{filename}
3313 @itemx --input @var{filename}
3314 The name of the input file. If this option is not used, then
3315 @command{windres} will use the first non-option argument as the input file
3316 name. If there are no non-option arguments, then @command{windres} will
3317 read from standard input. @command{windres} can not read a COFF file from
3320 @item -o @var{filename}
3321 @itemx --output @var{filename}
3322 The name of the output file. If this option is not used, then
3323 @command{windres} will use the first non-option argument, after any used
3324 for the input file name, as the output file name. If there is no
3325 non-option argument, then @command{windres} will write to standard output.
3326 @command{windres} can not write a COFF file to standard output. Note,
3327 for compatibility with @command{rc} the option @option{-fo} is also
3328 accepted, but its use is not recommended.
3330 @item -J @var{format}
3331 @itemx --input-format @var{format}
3332 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3333 @samp{coff}. If no input format is specified, @command{windres} will
3334 guess, as described above.
3336 @item -O @var{format}
3337 @itemx --output-format @var{format}
3338 The output format to generate. @var{format} may be @samp{res},
3339 @samp{rc}, or @samp{coff}. If no output format is specified,
3340 @command{windres} will guess, as described above.
3342 @item -F @var{target}
3343 @itemx --target @var{target}
3344 Specify the BFD format to use for a COFF file as input or output. This
3345 is a BFD target name; you can use the @option{--help} option to see a list
3346 of supported targets. Normally @command{windres} will use the default
3347 format, which is the first one listed by the @option{--help} option.
3349 @ref{Target Selection}.
3352 @item --preprocessor @var{program}
3353 When @command{windres} reads an @code{rc} file, it runs it through the C
3354 preprocessor first. This option may be used to specify the preprocessor
3355 to use, including any leading arguments. The default preprocessor
3356 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3358 @item -I @var{directory}
3359 @itemx --include-dir @var{directory}
3360 Specify an include directory to use when reading an @code{rc} file.
3361 @command{windres} will pass this to the preprocessor as an @option{-I}
3362 option. @command{windres} will also search this directory when looking for
3363 files named in the @code{rc} file. If the argument passed to this command
3364 matches any of the supported @var{formats} (as described in the @option{-J}
3365 option), it will issue a deprecation warning, and behave just like the
3366 @option{-J} option. New programs should not use this behaviour. If a
3367 directory happens to match a @var{format}, simple prefix it with @samp{./}
3368 to disable the backward compatibility.
3370 @item -D @var{target}
3371 @itemx --define @var{sym}[=@var{val}]
3372 Specify a @option{-D} option to pass to the preprocessor when reading an
3375 @item -U @var{target}
3376 @itemx --undefine @var{sym}
3377 Specify a @option{-U} option to pass to the preprocessor when reading an
3381 Ignored for compatibility with rc.
3384 Enable verbose mode. This tells you what the preprocessor is if you
3388 @item --codepage @var{val}
3389 Specify the default codepage to use when reading an @code{rc} file.
3390 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3391 codepage code. The valid range is from zero up to 0xffff, but the
3392 validity of the codepage is host and configuration dependent.
3395 @item --language @var{val}
3396 Specify the default language to use when reading an @code{rc} file.
3397 @var{val} should be a hexadecimal language code. The low eight bits are
3398 the language, and the high eight bits are the sublanguage.
3400 @item --use-temp-file
3401 Use a temporary file to instead of using popen to read the output of
3402 the preprocessor. Use this option if the popen implementation is buggy
3403 on the host (eg., certain non-English language versions of Windows 95 and
3404 Windows 98 are known to have buggy popen where the output will instead
3407 @item --no-use-temp-file
3408 Use popen, not a temporary file, to read the output of the preprocessor.
3409 This is the default behaviour.
3413 Prints a usage summary.
3417 Prints the version number for @command{windres}.
3420 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3421 this will turn on parser debugging.
3427 @c man begin SEEALSO windres
3428 the Info entries for @file{binutils}.
3437 @command{dlltool} is used to create the files needed to create dynamic
3438 link libraries (DLLs) on systems which understand PE format image
3439 files such as Windows. A DLL contains an export table which contains
3440 information that the runtime loader needs to resolve references from a
3441 referencing program.
3443 The export table is generated by this program by reading in a
3444 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3445 will be in the DLL. A @file{.o} file can contain information in
3446 special @samp{.drectve} sections with export information.
3449 @emph{Note:} @command{dlltool} is not always built as part of the
3450 binary utilities, since it is only useful for those targets which
3454 @c man title dlltool Create files needed to build and use DLLs.
3457 @c man begin SYNOPSIS dlltool
3458 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3459 [@option{-b}|@option{--base-file} @var{base-file-name}]
3460 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3461 [@option{-z}|@option{--output-def} @var{def-file-name}]
3462 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3463 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3464 [@option{--exclude-symbols} @var{list}]
3465 [@option{--no-default-excludes}]
3466 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3467 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3468 [@option{-a}|@option{--add-indirect}]
3469 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3470 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3471 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3472 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3473 [@option{--use-nul-prefixed-import-tables}]
3474 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3475 [@option{-i}|@option{--interwork}]
3476 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3477 [@option{-v}|@option{--verbose}]
3478 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3479 [object-file @dots{}]
3483 @c man begin DESCRIPTION dlltool
3485 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3486 @option{-b} options as well as object files specified on the command
3487 line. It then processes these inputs and if the @option{-e} option has
3488 been specified it creates a exports file. If the @option{-l} option
3489 has been specified it creates a library file and if the @option{-z} option
3490 has been specified it creates a def file. Any or all of the @option{-e},
3491 @option{-l} and @option{-z} options can be present in one invocation of
3494 When creating a DLL, along with the source for the DLL, it is necessary
3495 to have three other files. @command{dlltool} can help with the creation of
3498 The first file is a @file{.def} file which specifies which functions are
3499 exported from the DLL, which functions the DLL imports, and so on. This
3500 is a text file and can be created by hand, or @command{dlltool} can be used
3501 to create it using the @option{-z} option. In this case @command{dlltool}
3502 will scan the object files specified on its command line looking for
3503 those functions which have been specially marked as being exported and
3504 put entries for them in the @file{.def} file it creates.
3506 In order to mark a function as being exported from a DLL, it needs to
3507 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3508 section of the object file. This can be done in C by using the
3512 asm (".section .drectve");
3513 asm (".ascii \"-export:my_func\"");
3515 int my_func (void) @{ @dots{} @}
3518 The second file needed for DLL creation is an exports file. This file
3519 is linked with the object files that make up the body of the DLL and it
3520 handles the interface between the DLL and the outside world. This is a
3521 binary file and it can be created by giving the @option{-e} option to
3522 @command{dlltool} when it is creating or reading in a @file{.def} file.
3524 The third file needed for DLL creation is the library file that programs
3525 will link with in order to access the functions in the DLL (an `import
3526 library'). This file can be created by giving the @option{-l} option to
3527 dlltool when it is creating or reading in a @file{.def} file.
3529 @command{dlltool} builds the library file by hand, but it builds the
3530 exports file by creating temporary files containing assembler statements
3531 and then assembling these. The @option{-S} command line option can be
3532 used to specify the path to the assembler that dlltool will use,
3533 and the @option{-f} option can be used to pass specific flags to that
3534 assembler. The @option{-n} can be used to prevent dlltool from deleting
3535 these temporary assembler files when it is done, and if @option{-n} is
3536 specified twice then this will prevent dlltool from deleting the
3537 temporary object files it used to build the library.
3539 Here is an example of creating a DLL from a source file @samp{dll.c} and
3540 also creating a program (from an object file called @samp{program.o})
3545 dlltool -e exports.o -l dll.lib dll.o
3546 gcc dll.o exports.o -o dll.dll
3547 gcc program.o dll.lib -o program
3551 @command{dlltool} may also be used to query an existing import library
3552 to determine the name of the DLL to which it is associated. See the
3553 description of the @option{-I} or @option{--identify} option.
3557 @c man begin OPTIONS dlltool
3559 The command line options have the following meanings:
3563 @item -d @var{filename}
3564 @itemx --input-def @var{filename}
3565 @cindex input .def file
3566 Specifies the name of a @file{.def} file to be read in and processed.
3568 @item -b @var{filename}
3569 @itemx --base-file @var{filename}
3571 Specifies the name of a base file to be read in and processed. The
3572 contents of this file will be added to the relocation section in the
3573 exports file generated by dlltool.
3575 @item -e @var{filename}
3576 @itemx --output-exp @var{filename}
3577 Specifies the name of the export file to be created by dlltool.
3579 @item -z @var{filename}
3580 @itemx --output-def @var{filename}
3581 Specifies the name of the @file{.def} file to be created by dlltool.
3583 @item -l @var{filename}
3584 @itemx --output-lib @var{filename}
3585 Specifies the name of the library file to be created by dlltool.
3587 @item --export-all-symbols
3588 Treat all global and weak defined symbols found in the input object
3589 files as symbols to be exported. There is a small list of symbols which
3590 are not exported by default; see the @option{--no-default-excludes}
3591 option. You may add to the list of symbols to not export by using the
3592 @option{--exclude-symbols} option.
3594 @item --no-export-all-symbols
3595 Only export symbols explicitly listed in an input @file{.def} file or in
3596 @samp{.drectve} sections in the input object files. This is the default
3597 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3598 attributes in the source code.
3600 @item --exclude-symbols @var{list}
3601 Do not export the symbols in @var{list}. This is a list of symbol names
3602 separated by comma or colon characters. The symbol names should not
3603 contain a leading underscore. This is only meaningful when
3604 @option{--export-all-symbols} is used.
3606 @item --no-default-excludes
3607 When @option{--export-all-symbols} is used, it will by default avoid
3608 exporting certain special symbols. The current list of symbols to avoid
3609 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3610 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3611 to go ahead and export these special symbols. This is only meaningful
3612 when @option{--export-all-symbols} is used.
3615 @itemx --as @var{path}
3616 Specifies the path, including the filename, of the assembler to be used
3617 to create the exports file.
3619 @item -f @var{options}
3620 @itemx --as-flags @var{options}
3621 Specifies any specific command line options to be passed to the
3622 assembler when building the exports file. This option will work even if
3623 the @option{-S} option is not used. This option only takes one argument,
3624 and if it occurs more than once on the command line, then later
3625 occurrences will override earlier occurrences. So if it is necessary to
3626 pass multiple options to the assembler they should be enclosed in
3630 @itemx --dll-name @var{name}
3631 Specifies the name to be stored in the @file{.def} file as the name of
3632 the DLL when the @option{-e} option is used. If this option is not
3633 present, then the filename given to the @option{-e} option will be
3634 used as the name of the DLL.
3636 @item -m @var{machine}
3637 @itemx -machine @var{machine}
3638 Specifies the type of machine for which the library file should be
3639 built. @command{dlltool} has a built in default type, depending upon how
3640 it was created, but this option can be used to override that. This is
3641 normally only useful when creating DLLs for an ARM processor, when the
3642 contents of the DLL are actually encode using Thumb instructions.
3645 @itemx --add-indirect
3646 Specifies that when @command{dlltool} is creating the exports file it
3647 should add a section which allows the exported functions to be
3648 referenced without using the import library. Whatever the hell that
3652 @itemx --add-underscore
3653 Specifies that when @command{dlltool} is creating the exports file it
3654 should prepend an underscore to the names of @emph{all} exported symbols.
3656 @item --add-stdcall-underscore
3657 Specifies that when @command{dlltool} is creating the exports file it
3658 should prepend an underscore to the names of exported @emph{stdcall}
3659 functions. Variable names and non-stdcall function names are not modified.
3660 This option is useful when creating GNU-compatible import libs for third
3661 party DLLs that were built with MS-Windows tools.
3665 Specifies that when @command{dlltool} is creating the exports file it
3666 should not append the string @samp{@@ <number>}. These numbers are
3667 called ordinal numbers and they represent another way of accessing the
3668 function in a DLL, other than by name.
3671 @itemx --add-stdcall-alias
3672 Specifies that when @command{dlltool} is creating the exports file it
3673 should add aliases for stdcall symbols without @samp{@@ <number>}
3674 in addition to the symbols with @samp{@@ <number>}.
3677 @itemx --ext-prefix-alias @var{prefix}
3678 Causes @command{dlltool} to create external aliases for all DLL
3679 imports with the specified prefix. The aliases are created for both
3680 external and import symbols with no leading underscore.
3684 Specifies that when @command{dlltool} is creating the exports and library
3685 files it should omit the @code{.idata4} section. This is for compatibility
3686 with certain operating systems.
3688 @item --use-nul-prefixed-import-tables
3689 Specifies that when @command{dlltool} is creating the exports and library
3690 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
3691 element. This emulates old gnu import library generation of
3692 @code{dlltool}. By default this option is turned off.
3696 Specifies that when @command{dlltool} is creating the exports and library
3697 files it should omit the @code{.idata5} section. This is for compatibility
3698 with certain operating systems.
3700 @item -I @var{filename}
3701 @itemx --identify @var{filename}
3702 Specifies that @command{dlltool} should inspect the import library
3703 indicated by @var{filename} and report, on @code{stdout}, the name(s)
3704 of the associated DLL(s). This can be performed in addition to any
3705 other operations indicated by the other options and arguments.
3706 @command{dlltool} fails if the import library does not exist or is not
3707 actually an import library. See also @option{--identify-strict}.
3709 @item --identify-strict
3710 Modifies the behavior of the @option{--identify} option, such
3711 that an error is reported if @var{filename} is associated with
3716 Specifies that @command{dlltool} should mark the objects in the library
3717 file and exports file that it produces as supporting interworking
3718 between ARM and Thumb code.
3722 Makes @command{dlltool} preserve the temporary assembler files it used to
3723 create the exports file. If this option is repeated then dlltool will
3724 also preserve the temporary object files it uses to create the library
3727 @item -t @var{prefix}
3728 @itemx --temp-prefix @var{prefix}
3729 Makes @command{dlltool} use @var{prefix} when constructing the names of
3730 temporary assembler and object files. By default, the temp file prefix
3731 is generated from the pid.
3735 Make dlltool describe what it is doing.
3739 Displays a list of command line options and then exits.
3743 Displays dlltool's version number and then exits.
3750 * def file format:: The format of the dlltool @file{.def} file
3753 @node def file format
3754 @section The format of the @command{dlltool} @file{.def} file
3756 A @file{.def} file contains any number of the following commands:
3760 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3761 The result is going to be named @var{name}@code{.exe}.
3763 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3764 The result is going to be named @var{name}@code{.dll}.
3766 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3767 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3768 Declares @var{name1} as an exported symbol from the DLL, with optional
3769 ordinal number @var{integer}, or declares @var{name1} as an alias
3770 (forward) of the function @var{external-name} in the DLL
3773 @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{) ) *}
3774 Declares that @var{external-name} or the exported function whose
3775 ordinal number is @var{integer} is to be imported from the file
3776 @var{module-name}. If @var{internal-name} is specified then this is
3777 the name that the imported function will be referred to in the body of
3780 @item @code{DESCRIPTION} @var{string}
3781 Puts @var{string} into the output @file{.exp} file in the
3782 @code{.rdata} section.
3784 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3785 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3786 Generates @code{--stack} or @code{--heap}
3787 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
3788 section. The linker will see this and act upon it.
3790 @item @code{CODE} @var{attr} @code{+}
3791 @item @code{DATA} @var{attr} @code{+}
3792 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3793 Generates @code{--attr} @var{section-name} @var{attr} in the output
3794 @code{.drectve} section, where @var{attr} is one of @code{READ},
3795 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3796 this and act upon it.
3801 @c man begin SEEALSO dlltool
3802 The Info pages for @file{binutils}.
3809 @cindex ELF file information
3812 @c man title readelf Displays information about ELF files.
3815 @c man begin SYNOPSIS readelf
3816 readelf [@option{-a}|@option{--all}]
3817 [@option{-h}|@option{--file-header}]
3818 [@option{-l}|@option{--program-headers}|@option{--segments}]
3819 [@option{-S}|@option{--section-headers}|@option{--sections}]
3820 [@option{-g}|@option{--section-groups}]
3821 [@option{-t}|@option{--section-details}]
3822 [@option{-e}|@option{--headers}]
3823 [@option{-s}|@option{--syms}|@option{--symbols}]
3824 [@option{-n}|@option{--notes}]
3825 [@option{-r}|@option{--relocs}]
3826 [@option{-u}|@option{--unwind}]
3827 [@option{-d}|@option{--dynamic}]
3828 [@option{-V}|@option{--version-info}]
3829 [@option{-A}|@option{--arch-specific}]
3830 [@option{-D}|@option{--use-dynamic}]
3831 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
3832 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
3833 [@option{-c}|@option{--archive-index}]
3834 [@option{-w[lLiaprmfFsoR]}|
3835 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
3836 [@option{-I}|@option{-histogram}]
3837 [@option{-v}|@option{--version}]
3838 [@option{-W}|@option{--wide}]
3839 [@option{-H}|@option{--help}]
3840 @var{elffile}@dots{}
3844 @c man begin DESCRIPTION readelf
3846 @command{readelf} displays information about one or more ELF format object
3847 files. The options control what particular information to display.
3849 @var{elffile}@dots{} are the object files to be examined. 32-bit and
3850 64-bit ELF files are supported, as are archives containing ELF files.
3852 This program performs a similar function to @command{objdump} but it
3853 goes into more detail and it exists independently of the @sc{bfd}
3854 library, so if there is a bug in @sc{bfd} then readelf will not be
3859 @c man begin OPTIONS readelf
3861 The long and short forms of options, shown here as alternatives, are
3862 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3868 Equivalent to specifying @option{--file-header},
3869 @option{--program-headers}, @option{--sections}, @option{--symbols},
3870 @option{--relocs}, @option{--dynamic}, @option{--notes} and
3871 @option{--version-info}.
3874 @itemx --file-header
3875 @cindex ELF file header information
3876 Displays the information contained in the ELF header at the start of the
3880 @itemx --program-headers
3882 @cindex ELF program header information
3883 @cindex ELF segment information
3884 Displays the information contained in the file's segment headers, if it
3889 @itemx --section-headers
3890 @cindex ELF section information
3891 Displays the information contained in the file's section headers, if it
3895 @itemx --section-groups
3896 @cindex ELF section group information
3897 Displays the information contained in the file's section groups, if it
3901 @itemx --section-details
3902 @cindex ELF section information
3903 Displays the detailed section information. Implies @option{-S}.
3908 @cindex ELF symbol table information
3909 Displays the entries in symbol table section of the file, if it has one.
3913 Display all the headers in the file. Equivalent to @option{-h -l -S}.
3918 Displays the contents of the NOTE segments and/or sections, if any.
3922 @cindex ELF reloc information
3923 Displays the contents of the file's relocation section, if it has one.
3927 @cindex unwind information
3928 Displays the contents of the file's unwind section, if it has one. Only
3929 the unwind sections for IA64 ELF files are currently supported.
3933 @cindex ELF dynamic section information
3934 Displays the contents of the file's dynamic section, if it has one.
3937 @itemx --version-info
3938 @cindex ELF version sections informations
3939 Displays the contents of the version sections in the file, it they
3943 @itemx --arch-specific
3944 Displays architecture-specific information in the file, if there
3948 @itemx --use-dynamic
3949 When displaying symbols, this option makes @command{readelf} use the
3950 symbol table in the file's dynamic section, rather than the one in the
3953 @item -x <number or name>
3954 @itemx --hex-dump=<number or name>
3955 Displays the contents of the indicated section as a hexadecimal dump.
3956 A number identifies a particular section by index in the section table;
3957 any other string identifies all sections with that name in the object file.
3959 @item -p <number or name>
3960 @itemx --string-dump=<number or name>
3961 Displays the contents of the indicated section as printable strings.
3962 A number identifies a particular section by index in the section table;
3963 any other string identifies all sections with that name in the object file.
3966 @itemx --archive-index
3967 @cindex Archive file symbol index information
3968 Displays the file symbol index infomation contained in the header part
3969 of binary archives. Performs the same function as the @option{t}
3970 command to @command{ar}, but without using the BFD library. @xref{ar}.
3972 @item -w[lLiaprmfFsoR]
3973 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
3974 Displays the contents of the debug sections in the file, if any are
3975 present. If one of the optional letters or words follows the switch
3976 then only data found in those specific sections will be dumped.
3978 Note: the @option{=decodedline} option will display the interpreted
3979 contents of a .debug_line section whereas the @option{=rawline} option
3980 dumps the contents in a raw format.
3984 Display a histogram of bucket list lengths when displaying the contents
3985 of the symbol tables.
3989 Display the version number of readelf.
3993 Don't break output lines to fit into 80 columns. By default
3994 @command{readelf} breaks section header and segment listing lines for
3995 64-bit ELF files, so that they fit into 80 columns. This option causes
3996 @command{readelf} to print each section header resp. each segment one a
3997 single line, which is far more readable on terminals wider than 80 columns.
4001 Display the command line options understood by @command{readelf}.
4008 @c man begin SEEALSO readelf
4009 objdump(1), and the Info entries for @file{binutils}.
4013 @node Common Options
4014 @chapter Common Options
4016 The following command-line options are supported by all of the
4017 programs described in this manual.
4019 @c man begin OPTIONS
4021 @include at-file.texi
4025 Display the command-line options supported by the program.
4028 Display the version number of the program.
4030 @c man begin OPTIONS
4034 @node Selecting the Target System
4035 @chapter Selecting the Target System
4037 You can specify two aspects of the target system to the @sc{gnu}
4038 binary file utilities, each in several ways:
4048 In the following summaries, the lists of ways to specify values are in
4049 order of decreasing precedence. The ways listed first override those
4052 The commands to list valid values only list the values for which the
4053 programs you are running were configured. If they were configured with
4054 @option{--enable-targets=all}, the commands list most of the available
4055 values, but a few are left out; not all targets can be configured in at
4056 once because some of them can only be configured @dfn{native} (on hosts
4057 with the same type as the target system).
4060 * Target Selection::
4061 * Architecture Selection::
4064 @node Target Selection
4065 @section Target Selection
4067 A @dfn{target} is an object file format. A given target may be
4068 supported for multiple architectures (@pxref{Architecture Selection}).
4069 A target selection may also have variations for different operating
4070 systems or architectures.
4072 The command to list valid target values is @samp{objdump -i}
4073 (the first column of output contains the relevant information).
4075 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4076 @samp{a.out-sunos-big}.
4078 You can also specify a target using a configuration triplet. This is
4079 the same sort of name that is passed to @file{configure} to specify a
4080 target. When you use a configuration triplet as an argument, it must be
4081 fully canonicalized. You can see the canonical version of a triplet by
4082 running the shell script @file{config.sub} which is included with the
4085 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4086 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4088 @subheading @command{objdump} Target
4094 command line option: @option{-b} or @option{--target}
4097 environment variable @code{GNUTARGET}
4100 deduced from the input file
4103 @subheading @command{objcopy} and @command{strip} Input Target
4109 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4112 environment variable @code{GNUTARGET}
4115 deduced from the input file
4118 @subheading @command{objcopy} and @command{strip} Output Target
4124 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4127 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4130 environment variable @code{GNUTARGET}
4133 deduced from the input file
4136 @subheading @command{nm}, @command{size}, and @command{strings} Target
4142 command line option: @option{--target}
4145 environment variable @code{GNUTARGET}
4148 deduced from the input file
4151 @node Architecture Selection
4152 @section Architecture Selection
4154 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4155 to run. Its name may contain a colon, separating the name of the
4156 processor family from the name of the particular @sc{cpu}.
4158 The command to list valid architecture values is @samp{objdump -i} (the
4159 second column contains the relevant information).
4161 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4163 @subheading @command{objdump} Architecture
4169 command line option: @option{-m} or @option{--architecture}
4172 deduced from the input file
4175 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4181 deduced from the input file
4184 @node Reporting Bugs
4185 @chapter Reporting Bugs
4187 @cindex reporting bugs
4189 Your bug reports play an essential role in making the binary utilities
4192 Reporting a bug may help you by bringing a solution to your problem, or
4193 it may not. But in any case the principal function of a bug report is
4194 to help the entire community by making the next version of the binary
4195 utilities work better. Bug reports are your contribution to their
4198 In order for a bug report to serve its purpose, you must include the
4199 information that enables us to fix the bug.
4202 * Bug Criteria:: Have you found a bug?
4203 * Bug Reporting:: How to report bugs
4207 @section Have You Found a Bug?
4208 @cindex bug criteria
4210 If you are not sure whether you have found a bug, here are some guidelines:
4213 @cindex fatal signal
4216 If a binary utility gets a fatal signal, for any input whatever, that is
4217 a bug. Reliable utilities never crash.
4219 @cindex error on valid input
4221 If a binary utility produces an error message for valid input, that is a
4225 If you are an experienced user of binary utilities, your suggestions for
4226 improvement are welcome in any case.
4230 @section How to Report Bugs
4232 @cindex bugs, reporting
4234 A number of companies and individuals offer support for @sc{gnu}
4235 products. If you obtained the binary utilities from a support
4236 organization, we recommend you contact that organization first.
4238 You can find contact information for many support companies and
4239 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4243 In any event, we also recommend that you send bug reports for the binary
4244 utilities to @value{BUGURL}.
4247 The fundamental principle of reporting bugs usefully is this:
4248 @strong{report all the facts}. If you are not sure whether to state a
4249 fact or leave it out, state it!
4251 Often people omit facts because they think they know what causes the
4252 problem and assume that some details do not matter. Thus, you might
4253 assume that the name of a file you use in an example does not matter.
4254 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4255 a stray memory reference which happens to fetch from the location where
4256 that pathname is stored in memory; perhaps, if the pathname were
4257 different, the contents of that location would fool the utility into
4258 doing the right thing despite the bug. Play it safe and give a
4259 specific, complete example. That is the easiest thing for you to do,
4260 and the most helpful.
4262 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4263 it is new to us. Therefore, always write your bug reports on the assumption
4264 that the bug has not been reported previously.
4266 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4267 bell?'' This cannot help us fix a bug, so it is basically useless. We
4268 respond by asking for enough details to enable us to investigate.
4269 You might as well expedite matters by sending them to begin with.
4271 To enable us to fix the bug, you should include all these things:
4275 The version of the utility. Each utility announces it if you start it
4276 with the @option{--version} argument.
4278 Without this, we will not know whether there is any point in looking for
4279 the bug in the current version of the binary utilities.
4282 Any patches you may have applied to the source, including any patches
4283 made to the @code{BFD} library.
4286 The type of machine you are using, and the operating system name and
4290 What compiler (and its version) was used to compile the utilities---e.g.
4294 The command arguments you gave the utility to observe the bug. To
4295 guarantee you will not omit something important, list them all. A copy
4296 of the Makefile (or the output from make) is sufficient.
4298 If we were to try to guess the arguments, we would probably guess wrong
4299 and then we might not encounter the bug.
4302 A complete input file, or set of input files, that will reproduce the
4303 bug. If the utility is reading an object file or files, then it is
4304 generally most helpful to send the actual object files.
4306 If the source files were produced exclusively using @sc{gnu} programs
4307 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4308 may be OK to send the source files rather than the object files. In
4309 this case, be sure to say exactly what version of @command{gcc}, or
4310 whatever, was used to produce the object files. Also say how
4311 @command{gcc}, or whatever, was configured.
4314 A description of what behavior you observe that you believe is
4315 incorrect. For example, ``It gets a fatal signal.''
4317 Of course, if the bug is that the utility gets a fatal signal, then we
4318 will certainly notice it. But if the bug is incorrect output, we might
4319 not notice unless it is glaringly wrong. You might as well not give us
4320 a chance to make a mistake.
4322 Even if the problem you experience is a fatal signal, you should still
4323 say so explicitly. Suppose something strange is going on, such as your
4324 copy of the utility is out of sync, or you have encountered a bug in
4325 the C library on your system. (This has happened!) Your copy might
4326 crash and ours would not. If you told us to expect a crash, then when
4327 ours fails to crash, we would know that the bug was not happening for
4328 us. If you had not told us to expect a crash, then we would not be able
4329 to draw any conclusion from our observations.
4332 If you wish to suggest changes to the source, send us context diffs, as
4333 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4334 option. Always send diffs from the old file to the new file. If you
4335 wish to discuss something in the @command{ld} source, refer to it by
4336 context, not by line number.
4338 The line numbers in our development sources will not match those in your
4339 sources. Your line numbers would convey no useful information to us.
4342 Here are some things that are not necessary:
4346 A description of the envelope of the bug.
4348 Often people who encounter a bug spend a lot of time investigating
4349 which changes to the input file will make the bug go away and which
4350 changes will not affect it.
4352 This is often time consuming and not very useful, because the way we
4353 will find the bug is by running a single example under the debugger
4354 with breakpoints, not by pure deduction from a series of examples.
4355 We recommend that you save your time for something else.
4357 Of course, if you can find a simpler example to report @emph{instead}
4358 of the original one, that is a convenience for us. Errors in the
4359 output will be easier to spot, running under the debugger will take
4360 less time, and so on.
4362 However, simplification is not vital; if you do not want to do this,
4363 report the bug anyway and send us the entire test case you used.
4366 A patch for the bug.
4368 A patch for the bug does help us if it is a good one. But do not omit
4369 the necessary information, such as the test case, on the assumption that
4370 a patch is all we need. We might see problems with your patch and decide
4371 to fix the problem another way, or we might not understand it at all.
4373 Sometimes with programs as complicated as the binary utilities it is
4374 very hard to construct an example that will make the program follow a
4375 certain path through the code. If you do not send us the example, we
4376 will not be able to construct one, so we will not be able to verify that
4379 And if we cannot understand what bug you are trying to fix, or why your
4380 patch should be an improvement, we will not install it. A test case will
4381 help us to understand.
4384 A guess about what the bug is or what it depends on.
4386 Such guesses are usually wrong. Even we cannot guess right about such
4387 things without first using the debugger to find the facts.
4390 @node GNU Free Documentation License
4391 @appendix GNU Free Documentation License
4395 @node Binutils Index
4396 @unnumbered Binutils Index