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 [-]@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{-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}.
494 @c man begin SEEALSO ar
495 nm(1), ranlib(1), and the Info entries for @file{binutils}.
500 @section Controlling @command{ar} with a Script
503 ar -M [ <@var{script} ]
506 @cindex MRI compatibility, @command{ar}
507 @cindex scripts, @command{ar}
508 If you use the single command-line option @samp{-M} with @command{ar}, you
509 can control its operation with a rudimentary command language. This
510 form of @command{ar} operates interactively if standard input is coming
511 directly from a terminal. During interactive use, @command{ar} prompts for
512 input (the prompt is @samp{AR >}), and continues executing even after
513 errors. If you redirect standard input to a script file, no prompts are
514 issued, and @command{ar} abandons execution (with a nonzero exit code)
517 The @command{ar} command language is @emph{not} designed to be equivalent
518 to the command-line options; in fact, it provides somewhat less control
519 over archives. The only purpose of the command language is to ease the
520 transition to @sc{gnu} @command{ar} for developers who already have scripts
521 written for the MRI ``librarian'' program.
523 The syntax for the @command{ar} command language is straightforward:
526 commands are recognized in upper or lower case; for example, @code{LIST}
527 is the same as @code{list}. In the following descriptions, commands are
528 shown in upper case for clarity.
531 a single command may appear on each line; it is the first word on the
535 empty lines are allowed, and have no effect.
538 comments are allowed; text after either of the characters @samp{*}
539 or @samp{;} is ignored.
542 Whenever you use a list of names as part of the argument to an @command{ar}
543 command, you can separate the individual names with either commas or
544 blanks. Commas are shown in the explanations below, for clarity.
547 @samp{+} is used as a line continuation character; if @samp{+} appears
548 at the end of a line, the text on the following line is considered part
549 of the current command.
552 Here are the commands you can use in @command{ar} scripts, or when using
553 @command{ar} interactively. Three of them have special significance:
555 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
556 a temporary file required for most of the other commands.
558 @code{SAVE} commits the changes so far specified by the script. Prior
559 to @code{SAVE}, commands affect only the temporary copy of the current
563 @item ADDLIB @var{archive}
564 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
565 Add all the contents of @var{archive} (or, if specified, each named
566 @var{module} from @var{archive}) to the current archive.
568 Requires prior use of @code{OPEN} or @code{CREATE}.
570 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
571 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
572 @c else like "ar q..."
573 Add each named @var{member} as a module in the current archive.
575 Requires prior use of @code{OPEN} or @code{CREATE}.
578 Discard the contents of the current archive, canceling the effect of
579 any operations since the last @code{SAVE}. May be executed (with no
580 effect) even if no current archive is specified.
582 @item CREATE @var{archive}
583 Creates an archive, and makes it the current archive (required for many
584 other commands). The new archive is created with a temporary name; it
585 is not actually saved as @var{archive} until you use @code{SAVE}.
586 You can overwrite existing archives; similarly, the contents of any
587 existing file named @var{archive} will not be destroyed until @code{SAVE}.
589 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
590 Delete each listed @var{module} from the current archive; equivalent to
591 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
593 Requires prior use of @code{OPEN} or @code{CREATE}.
595 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
596 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
597 List each named @var{module} present in @var{archive}. The separate
598 command @code{VERBOSE} specifies the form of the output: when verbose
599 output is off, output is like that of @samp{ar -t @var{archive}
600 @var{module}@dots{}}. When verbose output is on, the listing is like
601 @samp{ar -tv @var{archive} @var{module}@dots{}}.
603 Output normally goes to the standard output stream; however, if you
604 specify @var{outputfile} as a final argument, @command{ar} directs the
608 Exit from @command{ar}, with a @code{0} exit code to indicate successful
609 completion. This command does not save the output file; if you have
610 changed the current archive since the last @code{SAVE} command, those
613 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
614 Extract each named @var{module} from the current archive, writing them
615 into the current directory as separate files. Equivalent to @samp{ar -x
616 @var{archive} @var{module}@dots{}}.
618 Requires prior use of @code{OPEN} or @code{CREATE}.
621 @c FIXME Tokens but no commands???
628 Display full contents of the current archive, in ``verbose'' style
629 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
630 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
631 enhancement, rather than present for MRI compatibility.)
633 Requires prior use of @code{OPEN} or @code{CREATE}.
635 @item OPEN @var{archive}
636 Opens an existing archive for use as the current archive (required for
637 many other commands). Any changes as the result of subsequent commands
638 will not actually affect @var{archive} until you next use @code{SAVE}.
640 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
641 In the current archive, replace each existing @var{module} (named in
642 the @code{REPLACE} arguments) from files in the current working directory.
643 To execute this command without errors, both the file, and the module in
644 the current archive, must exist.
646 Requires prior use of @code{OPEN} or @code{CREATE}.
649 Toggle an internal flag governing the output from @code{DIRECTORY}.
650 When the flag is on, @code{DIRECTORY} output matches output from
651 @samp{ar -tv }@dots{}.
654 Commit your changes to the current archive, and actually save it as a
655 file with the name specified in the last @code{CREATE} or @code{OPEN}
658 Requires prior use of @code{OPEN} or @code{CREATE}.
667 The @sc{gnu} linker @command{ld} is now described in a separate manual.
668 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
676 @c man title nm list symbols from object files
679 @c man begin SYNOPSIS nm
680 nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]
681 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
682 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
683 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
684 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
685 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
686 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
687 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
688 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
689 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
693 @c man begin DESCRIPTION nm
694 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
695 If no object files are listed as arguments, @command{nm} assumes the file
698 For each symbol, @command{nm} shows:
702 The symbol value, in the radix selected by options (see below), or
703 hexadecimal by default.
706 The symbol type. At least the following types are used; others are, as
707 well, depending on the object file format. If lowercase, the symbol is
708 local; if uppercase, the symbol is global (external).
710 @c Some more detail on exactly what these symbol types are used for
714 The symbol's value is absolute, and will not be changed by further
719 The symbol is in the uninitialized data section (known as BSS).
722 The symbol is common. Common symbols are uninitialized data. When
723 linking, multiple common symbols may appear with the same name. If the
724 symbol is defined anywhere, the common symbols are treated as undefined
727 For more details on common symbols, see the discussion of
728 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
733 The symbol is in the initialized data section.
737 The symbol is in an initialized data section for small objects. Some
738 object file formats permit more efficient access to small data objects,
739 such as a global int variable as opposed to a large global array.
742 The symbol is in a section specific to the implementation of DLLs.
745 The symbol is a debugging symbol.
748 The symbols is in a stack unwind section.
752 The symbol is in a read only data section.
756 The symbol is in an uninitialized data section for small objects.
760 The symbol is in the text (code) section.
763 The symbol is undefined.
767 The symbol is a weak object. When a weak defined symbol is linked with
768 a normal defined symbol, the normal defined symbol is used with no error.
769 When a weak undefined symbol is linked and the symbol is not defined,
770 the value of the weak symbol becomes zero with no error. On some
771 systems, uppercase indicates that a default value has been specified.
775 The symbol is a weak symbol that has not been specifically tagged as a
776 weak object symbol. When a weak defined symbol is linked with a normal
777 defined symbol, the normal defined symbol is used with no error.
778 When a weak undefined symbol is linked and the symbol is not defined,
779 the value of the symbol is determined in a system-specific manner without
780 error. On some systems, uppercase indicates that a default value has been
784 The symbol is a stabs symbol in an a.out object file. In this case, the
785 next values printed are the stabs other field, the stabs desc field, and
786 the stab type. Stabs symbols are used to hold debugging information.
788 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
789 ``stabs'' debug format}.
793 The symbol type is unknown, or object file format specific.
802 @c man begin OPTIONS nm
803 The long and short forms of options, shown here as alternatives, are
809 @itemx --print-file-name
810 @cindex input file name
812 @cindex source file name
813 Precede each symbol by the name of the input file (or archive member)
814 in which it was found, rather than identifying the input file once only,
815 before all of its symbols.
819 @cindex debugging symbols
820 Display all symbols, even debugger-only symbols; normally these are not
824 @cindex @command{nm} format
825 @cindex @command{nm} compatibility
826 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
829 @itemx --demangle[=@var{style}]
830 @cindex demangling in nm
831 Decode (@dfn{demangle}) low-level symbol names into user-level names.
832 Besides removing any initial underscore prepended by the system, this
833 makes C++ function names readable. Different compilers have different
834 mangling styles. The optional demangling style argument can be used to
835 choose an appropriate demangling style for your compiler. @xref{c++filt},
836 for more information on demangling.
839 Do not demangle low-level symbol names. This is the default.
843 @cindex dynamic symbols
844 Display the dynamic symbols rather than the normal symbols. This is
845 only meaningful for dynamic objects, such as certain types of shared
848 @item -f @var{format}
849 @itemx --format=@var{format}
850 @cindex @command{nm} format
851 @cindex @command{nm} compatibility
852 Use the output format @var{format}, which can be @code{bsd},
853 @code{sysv}, or @code{posix}. The default is @code{bsd}.
854 Only the first character of @var{format} is significant; it can be
855 either upper or lower case.
859 @cindex external symbols
860 Display only external symbols.
863 @itemx --line-numbers
864 @cindex symbol line numbers
865 For each symbol, use debugging information to try to find a filename and
866 line number. For a defined symbol, look for the line number of the
867 address of the symbol. For an undefined symbol, look for the line
868 number of a relocation entry which refers to the symbol. If line number
869 information can be found, print it after the other symbol information.
873 @itemx --numeric-sort
874 Sort symbols numerically by their addresses, rather than alphabetically
879 @cindex sorting symbols
880 Do not bother to sort the symbols in any order; print them in the order
885 Use the POSIX.2 standard output format instead of the default format.
886 Equivalent to @samp{-f posix}.
890 Print size, not the value, of defined symbols for the @code{bsd} output format.
894 @cindex symbol index, listing
895 When listing symbols from archive members, include the index: a mapping
896 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
897 contain definitions for which names.
900 @itemx --reverse-sort
901 Reverse the order of the sort (whether numeric or alphabetic); let the
905 Sort symbols by size. The size is computed as the difference between
906 the value of the symbol and the value of the symbol with the next higher
907 value. If the @code{bsd} output format is used the size of the symbol
908 is printed, rather than the value, and @samp{-S} must be used in order
909 both size and value to be printed.
912 Display symbols which have a target-specific special meaning. These
913 symbols are usually used by the target for some special processing and
914 are not normally helpful when included included in the normal symbol
915 lists. For example for ARM targets this option would skip the mapping
916 symbols used to mark transitions between ARM code, THUMB code and
920 @itemx --radix=@var{radix}
921 Use @var{radix} as the radix for printing the symbol values. It must be
922 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
924 @item --target=@var{bfdname}
925 @cindex object code format
926 Specify an object code format other than your system's default format.
927 @xref{Target Selection}, for more information.
930 @itemx --undefined-only
931 @cindex external symbols
932 @cindex undefined symbols
933 Display only undefined symbols (those external to each object file).
936 @cindex external symbols
937 @cindex undefined symbols
938 Display only defined symbols for each object file.
942 Show the version number of @command{nm} and exit.
945 This option is ignored for compatibility with the AIX version of
946 @command{nm}. It takes one parameter which must be the string
947 @option{32_64}. The default mode of AIX @command{nm} corresponds
948 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
951 Show a summary of the options to @command{nm} and exit.
957 @c man begin SEEALSO nm
958 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
965 @c man title objcopy copy and translate object files
968 @c man begin SYNOPSIS objcopy
969 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
970 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
971 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
972 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
973 [@option{-S}|@option{--strip-all}]
974 [@option{-g}|@option{--strip-debug}]
975 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
976 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
977 [@option{--strip-unneeded-symbol=}@var{symbolname}]
978 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
979 [@option{--localize-hidden}]
980 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
981 [@option{--globalize-symbol=}@var{symbolname}]
982 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
983 [@option{-w}|@option{--wildcard}]
984 [@option{-x}|@option{--discard-all}]
985 [@option{-X}|@option{--discard-locals}]
986 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
987 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
988 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
989 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
990 [@option{-p}|@option{--preserve-dates}]
991 [@option{--debugging}]
992 [@option{--gap-fill=}@var{val}]
993 [@option{--pad-to=}@var{address}]
994 [@option{--set-start=}@var{val}]
995 [@option{--adjust-start=}@var{incr}]
996 [@option{--change-addresses=}@var{incr}]
997 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
998 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
999 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
1000 [@option{--change-warnings}] [@option{--no-change-warnings}]
1001 [@option{--set-section-flags} @var{section}=@var{flags}]
1002 [@option{--add-section} @var{sectionname}=@var{filename}]
1003 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1004 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1005 [@option{--reverse-bytes=}@var{num}]
1006 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1007 [@option{--redefine-sym} @var{old}=@var{new}]
1008 [@option{--redefine-syms=}@var{filename}]
1010 [@option{--keep-symbols=}@var{filename}]
1011 [@option{--strip-symbols=}@var{filename}]
1012 [@option{--strip-unneeded-symbols=}@var{filename}]
1013 [@option{--keep-global-symbols=}@var{filename}]
1014 [@option{--localize-symbols=}@var{filename}]
1015 [@option{--globalize-symbols=}@var{filename}]
1016 [@option{--weaken-symbols=}@var{filename}]
1017 [@option{--alt-machine-code=}@var{index}]
1018 [@option{--prefix-symbols=}@var{string}]
1019 [@option{--prefix-sections=}@var{string}]
1020 [@option{--prefix-alloc-sections=}@var{string}]
1021 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1022 [@option{--keep-file-symbols}]
1023 [@option{--only-keep-debug}]
1024 [@option{--extract-symbol}]
1025 [@option{--writable-text}]
1026 [@option{--readonly-text}]
1029 [@option{-v}|@option{--verbose}]
1030 [@option{-V}|@option{--version}]
1031 [@option{--help}] [@option{--info}]
1032 @var{infile} [@var{outfile}]
1036 @c man begin DESCRIPTION objcopy
1037 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1038 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1039 read and write the object files. It can write the destination object
1040 file in a format different from that of the source object file. The
1041 exact behavior of @command{objcopy} is controlled by command-line options.
1042 Note that @command{objcopy} should be able to copy a fully linked file
1043 between any two formats. However, copying a relocatable object file
1044 between any two formats may not work as expected.
1046 @command{objcopy} creates temporary files to do its translations and
1047 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1048 translation work; it has access to all the formats described in @sc{bfd}
1049 and thus is able to recognize most formats without being told
1050 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1052 @command{objcopy} can be used to generate S-records by using an output
1053 target of @samp{srec} (e.g., use @samp{-O srec}).
1055 @command{objcopy} can be used to generate a raw binary file by using an
1056 output target of @samp{binary} (e.g., use @option{-O binary}). When
1057 @command{objcopy} generates a raw binary file, it will essentially produce
1058 a memory dump of the contents of the input object file. All symbols and
1059 relocation information will be discarded. The memory dump will start at
1060 the load address of the lowest section copied into the output file.
1062 When generating an S-record or a raw binary file, it may be helpful to
1063 use @option{-S} to remove sections containing debugging information. In
1064 some cases @option{-R} will be useful to remove sections which contain
1065 information that is not needed by the binary file.
1067 Note---@command{objcopy} is not able to change the endianness of its input
1068 files. If the input format has an endianness (some formats do not),
1069 @command{objcopy} can only copy the inputs into file formats that have the
1070 same endianness or which have no endianness (e.g., @samp{srec}).
1071 (However, see the @option{--reverse-bytes} option.)
1075 @c man begin OPTIONS objcopy
1079 @itemx @var{outfile}
1080 The input and output files, respectively.
1081 If you do not specify @var{outfile}, @command{objcopy} creates a
1082 temporary file and destructively renames the result with
1083 the name of @var{infile}.
1085 @item -I @var{bfdname}
1086 @itemx --input-target=@var{bfdname}
1087 Consider the source file's object format to be @var{bfdname}, rather than
1088 attempting to deduce it. @xref{Target Selection}, for more information.
1090 @item -O @var{bfdname}
1091 @itemx --output-target=@var{bfdname}
1092 Write the output file using the object format @var{bfdname}.
1093 @xref{Target Selection}, for more information.
1095 @item -F @var{bfdname}
1096 @itemx --target=@var{bfdname}
1097 Use @var{bfdname} as the object format for both the input and the output
1098 file; i.e., simply transfer data from source to destination with no
1099 translation. @xref{Target Selection}, for more information.
1101 @item -B @var{bfdarch}
1102 @itemx --binary-architecture=@var{bfdarch}
1103 Useful when transforming a raw binary input file into an object file.
1104 In this case the output architecture can be set to @var{bfdarch}. This
1105 option will be ignored if the input file has a known @var{bfdarch}. You
1106 can access this binary data inside a program by referencing the special
1107 symbols that are created by the conversion process. These symbols are
1108 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1109 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1110 an object file and then access it in your code using these symbols.
1112 @item -j @var{sectionname}
1113 @itemx --only-section=@var{sectionname}
1114 Copy only the named section from the input file to the output file.
1115 This option may be given more than once. Note that using this option
1116 inappropriately may make the output file unusable.
1118 @item -R @var{sectionname}
1119 @itemx --remove-section=@var{sectionname}
1120 Remove any section named @var{sectionname} from the output file. This
1121 option may be given more than once. Note that using this option
1122 inappropriately may make the output file unusable.
1126 Do not copy relocation and symbol information from the source file.
1129 @itemx --strip-debug
1130 Do not copy debugging symbols or sections from the source file.
1132 @item --strip-unneeded
1133 Strip all symbols that are not needed for relocation processing.
1135 @item -K @var{symbolname}
1136 @itemx --keep-symbol=@var{symbolname}
1137 When stripping symbols, keep symbol @var{symbolname} even if it would
1138 normally be stripped. This option may be given more than once.
1140 @item -N @var{symbolname}
1141 @itemx --strip-symbol=@var{symbolname}
1142 Do not copy symbol @var{symbolname} from the source file. This option
1143 may be given more than once.
1145 @item --strip-unneeded-symbol=@var{symbolname}
1146 Do not copy symbol @var{symbolname} from the source file unless it is needed
1147 by a relocation. This option may be given more than once.
1149 @item -G @var{symbolname}
1150 @itemx --keep-global-symbol=@var{symbolname}
1151 Keep only symbol @var{symbolname} global. Make all other symbols local
1152 to the file, so that they are not visible externally. This option may
1153 be given more than once.
1155 @item --localize-hidden
1156 In an ELF object, mark all symbols that have hidden or internal visibility
1157 as local. This option applies on top of symbol-specific localization options
1158 such as @option{-L}.
1160 @item -L @var{symbolname}
1161 @itemx --localize-symbol=@var{symbolname}
1162 Make symbol @var{symbolname} local to the file, so that it is not
1163 visible externally. This option may be given more than once.
1165 @item -W @var{symbolname}
1166 @itemx --weaken-symbol=@var{symbolname}
1167 Make symbol @var{symbolname} weak. This option may be given more than once.
1169 @item --globalize-symbol=@var{symbolname}
1170 Give symbol @var{symbolname} global scoping so that it is visible
1171 outside of the file in which it is defined. This option may be given
1176 Permit regular expressions in @var{symbolname}s used in other command
1177 line options. The question mark (?), asterisk (*), backslash (\) and
1178 square brackets ([]) operators can be used anywhere in the symbol
1179 name. If the first character of the symbol name is the exclamation
1180 point (!) then the sense of the switch is reversed for that symbol.
1187 would cause objcopy to weaken all symbols that start with ``fo''
1188 except for the symbol ``foo''.
1191 @itemx --discard-all
1192 Do not copy non-global symbols from the source file.
1193 @c FIXME any reason to prefer "non-global" to "local" here?
1196 @itemx --discard-locals
1197 Do not copy compiler-generated local symbols.
1198 (These usually start with @samp{L} or @samp{.}.)
1201 @itemx --byte=@var{byte}
1202 Keep only every @var{byte}th byte of the input file (header data is not
1203 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1204 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1205 option, or the default of 4. This option is useful for creating files
1206 to program @sc{rom}. It is typically used with an @code{srec} output
1209 @item -i @var{interleave}
1210 @itemx --interleave=@var{interleave}
1211 Only copy one out of every @var{interleave} bytes. Select which byte to
1212 copy with the @option{-b} or @option{--byte} option. The default is 4.
1213 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1217 @itemx --preserve-dates
1218 Set the access and modification dates of the output file to be the same
1219 as those of the input file.
1222 Convert debugging information, if possible. This is not the default
1223 because only certain debugging formats are supported, and the
1224 conversion process can be time consuming.
1226 @item --gap-fill @var{val}
1227 Fill gaps between sections with @var{val}. This operation applies to
1228 the @emph{load address} (LMA) of the sections. It is done by increasing
1229 the size of the section with the lower address, and filling in the extra
1230 space created with @var{val}.
1232 @item --pad-to @var{address}
1233 Pad the output file up to the load address @var{address}. This is
1234 done by increasing the size of the last section. The extra space is
1235 filled in with the value specified by @option{--gap-fill} (default zero).
1237 @item --set-start @var{val}
1238 Set the start address of the new file to @var{val}. Not all object file
1239 formats support setting the start address.
1241 @item --change-start @var{incr}
1242 @itemx --adjust-start @var{incr}
1243 @cindex changing start address
1244 Change the start address by adding @var{incr}. Not all object file
1245 formats support setting the start address.
1247 @item --change-addresses @var{incr}
1248 @itemx --adjust-vma @var{incr}
1249 @cindex changing object addresses
1250 Change the VMA and LMA addresses of all sections, as well as the start
1251 address, by adding @var{incr}. Some object file formats do not permit
1252 section addresses to be changed arbitrarily. Note that this does not
1253 relocate the sections; if the program expects sections to be loaded at a
1254 certain address, and this option is used to change the sections such
1255 that they are loaded at a different address, the program may fail.
1257 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1258 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1259 @cindex changing section address
1260 Set or change both the VMA address and the LMA address of the named
1261 @var{section}. If @samp{=} is used, the section address is set to
1262 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1263 section address. See the comments under @option{--change-addresses},
1264 above. If @var{section} does not exist in the input file, a warning will
1265 be issued, unless @option{--no-change-warnings} is used.
1267 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1268 @cindex changing section LMA
1269 Set or change the LMA address of the named @var{section}. The LMA
1270 address is the address where the section will be loaded into memory at
1271 program load time. Normally this is the same as the VMA address, which
1272 is the address of the section at program run time, but on some systems,
1273 especially those where a program is held in ROM, the two can be
1274 different. If @samp{=} is used, the section address is set to
1275 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1276 section address. See the comments under @option{--change-addresses},
1277 above. If @var{section} does not exist in the input file, a warning
1278 will be issued, unless @option{--no-change-warnings} is used.
1280 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1281 @cindex changing section VMA
1282 Set or change the VMA address of the named @var{section}. The VMA
1283 address is the address where the section will be located once the
1284 program has started executing. Normally this is the same as the LMA
1285 address, which is the address where the section will be loaded into
1286 memory, but on some systems, especially those where a program is held in
1287 ROM, the two can be different. If @samp{=} is used, the section address
1288 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1289 from the section address. See the comments under
1290 @option{--change-addresses}, above. If @var{section} does not exist in
1291 the input file, a warning will be issued, unless
1292 @option{--no-change-warnings} is used.
1294 @item --change-warnings
1295 @itemx --adjust-warnings
1296 If @option{--change-section-address} or @option{--change-section-lma} or
1297 @option{--change-section-vma} is used, and the named section does not
1298 exist, issue a warning. This is the default.
1300 @item --no-change-warnings
1301 @itemx --no-adjust-warnings
1302 Do not issue a warning if @option{--change-section-address} or
1303 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1304 if the named section does not exist.
1306 @item --set-section-flags @var{section}=@var{flags}
1307 Set the flags for the named section. The @var{flags} argument is a
1308 comma separated string of flag names. The recognized names are
1309 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1310 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1311 @samp{debug}. You can set the @samp{contents} flag for a section which
1312 does not have contents, but it is not meaningful to clear the
1313 @samp{contents} flag of a section which does have contents--just remove
1314 the section instead. Not all flags are meaningful for all object file
1317 @item --add-section @var{sectionname}=@var{filename}
1318 Add a new section named @var{sectionname} while copying the file. The
1319 contents of the new section are taken from the file @var{filename}. The
1320 size of the section will be the size of the file. This option only
1321 works on file formats which can support sections with arbitrary names.
1323 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1324 Rename a section from @var{oldname} to @var{newname}, optionally
1325 changing the section's flags to @var{flags} in the process. This has
1326 the advantage over usng a linker script to perform the rename in that
1327 the output stays as an object file and does not become a linked
1330 This option is particularly helpful when the input format is binary,
1331 since this will always create a section called .data. If for example,
1332 you wanted instead to create a section called .rodata containing binary
1333 data you could use the following command line to achieve it:
1336 objcopy -I binary -O <output_format> -B <architecture> \
1337 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1338 <input_binary_file> <output_object_file>
1341 @item --change-leading-char
1342 Some object file formats use special characters at the start of
1343 symbols. The most common such character is underscore, which compilers
1344 often add before every symbol. This option tells @command{objcopy} to
1345 change the leading character of every symbol when it converts between
1346 object file formats. If the object file formats use the same leading
1347 character, this option has no effect. Otherwise, it will add a
1348 character, or remove a character, or change a character, as
1351 @item --remove-leading-char
1352 If the first character of a global symbol is a special symbol leading
1353 character used by the object file format, remove the character. The
1354 most common symbol leading character is underscore. This option will
1355 remove a leading underscore from all global symbols. This can be useful
1356 if you want to link together objects of different file formats with
1357 different conventions for symbol names. This is different from
1358 @option{--change-leading-char} because it always changes the symbol name
1359 when appropriate, regardless of the object file format of the output
1362 @item --reverse-bytes=@var{num}
1363 Reverse the bytes in a section with output contents. A section length must
1364 be evenly divisible by the value given in order for the swap to be able to
1365 take place. Reversing takes place before the interleaving is performed.
1367 This option is used typically in generating ROM images for problematic
1368 target systems. For example, on some target boards, the 32-bit words
1369 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1370 regardless of the CPU byte order. Depending on the programming model, the
1371 endianness of the ROM may need to be modified.
1373 Consider a simple file with a section containing the following eight
1374 bytes: @code{12345678}.
1376 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1377 output file would be ordered @code{21436587}.
1379 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1380 output file would be ordered @code{43218765}.
1382 By using @samp{--reverse-bytes=2} for the above example, followed by
1383 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1384 output file would be ordered @code{34127856}.
1386 @item --srec-len=@var{ival}
1387 Meaningful only for srec output. Set the maximum length of the Srecords
1388 being produced to @var{ival}. This length covers both address, data and
1391 @item --srec-forceS3
1392 Meaningful only for srec output. Avoid generation of S1/S2 records,
1393 creating S3-only record format.
1395 @item --redefine-sym @var{old}=@var{new}
1396 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1397 when one is trying link two things together for which you have no
1398 source, and there are name collisions.
1400 @item --redefine-syms=@var{filename}
1401 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1402 listed in the file @var{filename}. @var{filename} is simply a flat file,
1403 with one symbol pair per line. Line comments may be introduced by the hash
1404 character. This option may be given more than once.
1407 Change all global symbols in the file to be weak. This can be useful
1408 when building an object which will be linked against other objects using
1409 the @option{-R} option to the linker. This option is only effective when
1410 using an object file format which supports weak symbols.
1412 @item --keep-symbols=@var{filename}
1413 Apply @option{--keep-symbol} option to each symbol listed in the file
1414 @var{filename}. @var{filename} is simply a flat file, with one symbol
1415 name per line. Line comments may be introduced by the hash character.
1416 This option may be given more than once.
1418 @item --strip-symbols=@var{filename}
1419 Apply @option{--strip-symbol} option to each symbol listed in the file
1420 @var{filename}. @var{filename} is simply a flat file, with one symbol
1421 name per line. Line comments may be introduced by the hash character.
1422 This option may be given more than once.
1424 @item --strip-unneeded-symbols=@var{filename}
1425 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1426 the file @var{filename}. @var{filename} is simply a flat file, with one
1427 symbol name per line. Line comments may be introduced by the hash
1428 character. This option may be given more than once.
1430 @item --keep-global-symbols=@var{filename}
1431 Apply @option{--keep-global-symbol} option to each symbol listed in the
1432 file @var{filename}. @var{filename} is simply a flat file, with one
1433 symbol name per line. Line comments may be introduced by the hash
1434 character. This option may be given more than once.
1436 @item --localize-symbols=@var{filename}
1437 Apply @option{--localize-symbol} option to each symbol listed in the file
1438 @var{filename}. @var{filename} is simply a flat file, with one symbol
1439 name per line. Line comments may be introduced by the hash character.
1440 This option may be given more than once.
1442 @item --globalize-symbols=@var{filename}
1443 Apply @option{--globalize-symbol} option to each symbol listed in the file
1444 @var{filename}. @var{filename} is simply a flat file, with one symbol
1445 name per line. Line comments may be introduced by the hash character.
1446 This option may be given more than once.
1448 @item --weaken-symbols=@var{filename}
1449 Apply @option{--weaken-symbol} option to each symbol listed in the file
1450 @var{filename}. @var{filename} is simply a flat file, with one symbol
1451 name per line. Line comments may be introduced by the hash character.
1452 This option may be given more than once.
1454 @item --alt-machine-code=@var{index}
1455 If the output architecture has alternate machine codes, use the
1456 @var{index}th code instead of the default one. This is useful in case
1457 a machine is assigned an official code and the tool-chain adopts the
1458 new code, but other applications still depend on the original code
1459 being used. For ELF based architectures if the @var{index}
1460 alternative does not exist then the value is treated as an absolute
1461 number to be stored in the e_machine field of the ELF header.
1463 @item --writable-text
1464 Mark the output text as writable. This option isn't meaningful for all
1465 object file formats.
1467 @item --readonly-text
1468 Make the output text write protected. This option isn't meaningful for all
1469 object file formats.
1472 Mark the output file as demand paged. This option isn't meaningful for all
1473 object file formats.
1476 Mark the output file as impure. This option isn't meaningful for all
1477 object file formats.
1479 @item --prefix-symbols=@var{string}
1480 Prefix all symbols in the output file with @var{string}.
1482 @item --prefix-sections=@var{string}
1483 Prefix all section names in the output file with @var{string}.
1485 @item --prefix-alloc-sections=@var{string}
1486 Prefix all the names of all allocated sections in the output file with
1489 @item --add-gnu-debuglink=@var{path-to-file}
1490 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1491 and adds it to the output file.
1493 @item --keep-file-symbols
1494 When stripping a file, perhaps with @option{--strip-debug} or
1495 @option{--strip-unneeded}, retain any symbols specifying source file names,
1496 which would otherwise get stripped.
1498 @item --only-keep-debug
1499 Strip a file, removing contents of any sections that would not be
1500 stripped by @option{--strip-debug} and leaving the debugging sections
1501 intact. In ELF files, this preserves all note sections in the output.
1503 The intention is that this option will be used in conjunction with
1504 @option{--add-gnu-debuglink} to create a two part executable. One a
1505 stripped binary which will occupy less space in RAM and in a
1506 distribution and the second a debugging information file which is only
1507 needed if debugging abilities are required. The suggested procedure
1508 to create these files is as follows:
1511 @item Link the executable as normal. Assuming that is is called
1513 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1514 create a file containing the debugging info.
1515 @item Run @code{objcopy --strip-debug foo} to create a
1516 stripped executable.
1517 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1518 to add a link to the debugging info into the stripped executable.
1521 Note---the choice of @code{.dbg} as an extension for the debug info
1522 file is arbitrary. Also the @code{--only-keep-debug} step is
1523 optional. You could instead do this:
1526 @item Link the executable as normal.
1527 @item Copy @code{foo} to @code{foo.full}
1528 @item Run @code{objcopy --strip-debug foo}
1529 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1532 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1533 full executable. It does not have to be a file created by the
1534 @option{--only-keep-debug} switch.
1536 Note---this switch is only intended for use on fully linked files. It
1537 does not make sense to use it on object files where the debugging
1538 information may be incomplete. Besides the gnu_debuglink feature
1539 currently only supports the presence of one filename containing
1540 debugging information, not multiple filenames on a one-per-object-file
1543 @item --extract-symbol
1544 Keep the file's section flags and symbols but remove all section data.
1545 Specifically, the option:
1548 @item removes the contents of all sections;
1549 @item sets the size of every section to zero; and
1550 @item sets the file's start address to zero.
1553 This option is used to build a @file{.sym} file for a VxWorks kernel.
1554 It can also be a useful way of reducing the size of a @option{--just-symbols}
1559 Show the version number of @command{objcopy}.
1563 Verbose output: list all object files modified. In the case of
1564 archives, @samp{objcopy -V} lists all members of the archive.
1567 Show a summary of the options to @command{objcopy}.
1570 Display a list showing all architectures and object formats available.
1576 @c man begin SEEALSO objcopy
1577 ld(1), objdump(1), and the Info entries for @file{binutils}.
1584 @cindex object file information
1587 @c man title objdump display information from object files.
1590 @c man begin SYNOPSIS objdump
1591 objdump [@option{-a}|@option{--archive-headers}]
1592 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1593 [@option{-C}|@option{--demangle}[=@var{style}] ]
1594 [@option{-d}|@option{--disassemble}]
1595 [@option{-D}|@option{--disassemble-all}]
1596 [@option{-z}|@option{--disassemble-zeroes}]
1597 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1598 [@option{-f}|@option{--file-headers}]
1599 [@option{-F}|@option{--file-offsets}]
1600 [@option{--file-start-context}]
1601 [@option{-g}|@option{--debugging}]
1602 [@option{-e}|@option{--debugging-tags}]
1603 [@option{-h}|@option{--section-headers}|@option{--headers}]
1604 [@option{-i}|@option{--info}]
1605 [@option{-j} @var{section}|@option{--section=}@var{section}]
1606 [@option{-l}|@option{--line-numbers}]
1607 [@option{-S}|@option{--source}]
1608 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1609 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1610 [@option{-p}|@option{--private-headers}]
1611 [@option{-r}|@option{--reloc}]
1612 [@option{-R}|@option{--dynamic-reloc}]
1613 [@option{-s}|@option{--full-contents}]
1614 [@option{-W[lLiaprmfFsoR]}|
1615 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
1616 [@option{-G}|@option{--stabs}]
1617 [@option{-t}|@option{--syms}]
1618 [@option{-T}|@option{--dynamic-syms}]
1619 [@option{-x}|@option{--all-headers}]
1620 [@option{-w}|@option{--wide}]
1621 [@option{--start-address=}@var{address}]
1622 [@option{--stop-address=}@var{address}]
1623 [@option{--prefix-addresses}]
1624 [@option{--[no-]show-raw-insn}]
1625 [@option{--adjust-vma=}@var{offset}]
1626 [@option{--special-syms}]
1627 [@option{--prefix=}@var{prefix}]
1628 [@option{--prefix-strip=}@var{level}]
1629 [@option{-V}|@option{--version}]
1630 [@option{-H}|@option{--help}]
1631 @var{objfile}@dots{}
1635 @c man begin DESCRIPTION objdump
1637 @command{objdump} displays information about one or more object files.
1638 The options control what particular information to display. This
1639 information is mostly useful to programmers who are working on the
1640 compilation tools, as opposed to programmers who just want their
1641 program to compile and work.
1643 @var{objfile}@dots{} are the object files to be examined. When you
1644 specify archives, @command{objdump} shows information on each of the member
1649 @c man begin OPTIONS objdump
1651 The long and short forms of options, shown here as alternatives, are
1652 equivalent. At least one option from the list
1653 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1657 @itemx --archive-header
1658 @cindex archive headers
1659 If any of the @var{objfile} files are archives, display the archive
1660 header information (in a format similar to @samp{ls -l}). Besides the
1661 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1662 the object file format of each archive member.
1664 @item --adjust-vma=@var{offset}
1665 @cindex section addresses in objdump
1666 @cindex VMA in objdump
1667 When dumping information, first add @var{offset} to all the section
1668 addresses. This is useful if the section addresses do not correspond to
1669 the symbol table, which can happen when putting sections at particular
1670 addresses when using a format which can not represent section addresses,
1673 @item -b @var{bfdname}
1674 @itemx --target=@var{bfdname}
1675 @cindex object code format
1676 Specify that the object-code format for the object files is
1677 @var{bfdname}. This option may not be necessary; @var{objdump} can
1678 automatically recognize many formats.
1682 objdump -b oasys -m vax -h fu.o
1685 displays summary information from the section headers (@option{-h}) of
1686 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1687 file in the format produced by Oasys compilers. You can list the
1688 formats available with the @option{-i} option.
1689 @xref{Target Selection}, for more information.
1692 @itemx --demangle[=@var{style}]
1693 @cindex demangling in objdump
1694 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1695 Besides removing any initial underscore prepended by the system, this
1696 makes C++ function names readable. Different compilers have different
1697 mangling styles. The optional demangling style argument can be used to
1698 choose an appropriate demangling style for your compiler. @xref{c++filt},
1699 for more information on demangling.
1703 Display debugging information. This attempts to parse STABS and IEEE
1704 debugging format information stored in the file and print it out using
1705 a C like syntax. If neither of these formats are found this option
1706 falls back on the @option{-W} option to print any DWARF information in
1710 @itemx --debugging-tags
1711 Like @option{-g}, but the information is generated in a format compatible
1715 @itemx --disassemble
1716 @cindex disassembling object code
1717 @cindex machine instructions
1718 Display the assembler mnemonics for the machine instructions from
1719 @var{objfile}. This option only disassembles those sections which are
1720 expected to contain instructions.
1723 @itemx --disassemble-all
1724 Like @option{-d}, but disassemble the contents of all sections, not just
1725 those expected to contain instructions.
1727 @item --prefix-addresses
1728 When disassembling, print the complete address on each line. This is
1729 the older disassembly format.
1733 @itemx --endian=@{big|little@}
1735 @cindex disassembly endianness
1736 Specify the endianness of the object files. This only affects
1737 disassembly. This can be useful when disassembling a file format which
1738 does not describe endianness information, such as S-records.
1741 @itemx --file-headers
1742 @cindex object file header
1743 Display summary information from the overall header of
1744 each of the @var{objfile} files.
1747 @itemx --file-offsets
1748 @cindex object file offsets
1749 When disassembling sections, whenever a symbol is displayed, also
1750 display the file offset of the region of data that is about to be
1751 dumped. If zeroes are being skipped, then when disassembly resumes,
1752 tell the user how many zeroes were skipped and the file offset of the
1753 location from where the disassembly resumes. When dumping sections,
1754 display the file offset of the location from where the dump starts.
1756 @item --file-start-context
1757 @cindex source code context
1758 Specify that when displaying interlisted source code/disassembly
1759 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1760 context to the start of the file.
1763 @itemx --section-headers
1765 @cindex section headers
1766 Display summary information from the section headers of the
1769 File segments may be relocated to nonstandard addresses, for example by
1770 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1771 @command{ld}. However, some object file formats, such as a.out, do not
1772 store the starting address of the file segments. In those situations,
1773 although @command{ld} relocates the sections correctly, using @samp{objdump
1774 -h} to list the file section headers cannot show the correct addresses.
1775 Instead, it shows the usual addresses, which are implicit for the
1780 Print a summary of the options to @command{objdump} and exit.
1784 @cindex architectures available
1785 @cindex object formats available
1786 Display a list showing all architectures and object formats available
1787 for specification with @option{-b} or @option{-m}.
1790 @itemx --section=@var{name}
1791 @cindex section information
1792 Display information only for section @var{name}.
1795 @itemx --line-numbers
1796 @cindex source filenames for object files
1797 Label the display (using debugging information) with the filename and
1798 source line numbers corresponding to the object code or relocs shown.
1799 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1801 @item -m @var{machine}
1802 @itemx --architecture=@var{machine}
1803 @cindex architecture
1804 @cindex disassembly architecture
1805 Specify the architecture to use when disassembling object files. This
1806 can be useful when disassembling object files which do not describe
1807 architecture information, such as S-records. You can list the available
1808 architectures with the @option{-i} option.
1810 @item -M @var{options}
1811 @itemx --disassembler-options=@var{options}
1812 Pass target specific information to the disassembler. Only supported on
1813 some targets. If it is necessary to specify more than one
1814 disassembler option then multiple @option{-M} options can be used or
1815 can be placed together into a comma separated list.
1817 If the target is an ARM architecture then this switch can be used to
1818 select which register name set is used during disassembler. Specifying
1819 @option{-M reg-names-std} (the default) will select the register names as
1820 used in ARM's instruction set documentation, but with register 13 called
1821 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1822 @option{-M reg-names-apcs} will select the name set used by the ARM
1823 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1824 just use @samp{r} followed by the register number.
1826 There are also two variants on the APCS register naming scheme enabled
1827 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1828 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1829 with the normal register names or the special register names).
1831 This option can also be used for ARM architectures to force the
1832 disassembler to interpret all instructions as Thumb instructions by
1833 using the switch @option{--disassembler-options=force-thumb}. This can be
1834 useful when attempting to disassemble thumb code produced by other
1837 For the x86, some of the options duplicate functions of the @option{-m}
1838 switch, but allow finer grained control. Multiple selections from the
1839 following may be specified as a comma separated string.
1840 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
1841 the given architecture. @option{intel} and @option{att} select between
1842 intel syntax mode and AT&T syntax mode.
1843 @option{intel-mnemonic} and @option{att-mnemonic} select between
1844 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
1845 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
1846 @option{addr64}, @option{addr32},
1847 @option{addr16}, @option{data32} and @option{data16} specify the default
1848 address size and operand size. These four options will be overridden if
1849 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
1850 option string. Lastly, @option{suffix}, when in AT&T mode,
1851 instructs the disassembler to print a mnemonic suffix even when the
1852 suffix could be inferred by the operands.
1854 For PowerPC, @option{booke} controls the disassembly of BookE
1855 instructions. @option{32} and @option{64} select PowerPC and
1856 PowerPC64 disassembly, respectively. @option{e300} selects
1857 disassembly for the e300 family. @option{440} selects disassembly for
1858 the PowerPC 440. @option{ppcps} selects disassembly for the paired
1859 single instructions of the PPC750CL.
1861 For MIPS, this option controls the printing of instruction mnemonic
1862 names and register names in disassembled instructions. Multiple
1863 selections from the following may be specified as a comma separated
1864 string, and invalid options are ignored:
1868 Print the 'raw' instruction mnemonic instead of some pseudo
1869 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
1870 'sll' instead of 'nop', etc.
1872 @item gpr-names=@var{ABI}
1873 Print GPR (general-purpose register) names as appropriate
1874 for the specified ABI. By default, GPR names are selected according to
1875 the ABI of the binary being disassembled.
1877 @item fpr-names=@var{ABI}
1878 Print FPR (floating-point register) names as
1879 appropriate for the specified ABI. By default, FPR numbers are printed
1882 @item cp0-names=@var{ARCH}
1883 Print CP0 (system control coprocessor; coprocessor 0) register names
1884 as appropriate for the CPU or architecture specified by
1885 @var{ARCH}. By default, CP0 register names are selected according to
1886 the architecture and CPU of the binary being disassembled.
1888 @item hwr-names=@var{ARCH}
1889 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1890 as appropriate for the CPU or architecture specified by
1891 @var{ARCH}. By default, HWR names are selected according to
1892 the architecture and CPU of the binary being disassembled.
1894 @item reg-names=@var{ABI}
1895 Print GPR and FPR names as appropriate for the selected ABI.
1897 @item reg-names=@var{ARCH}
1898 Print CPU-specific register names (CP0 register and HWR names)
1899 as appropriate for the selected CPU or architecture.
1902 For any of the options listed above, @var{ABI} or
1903 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
1904 rather than names, for the selected types of registers.
1905 You can list the available values of @var{ABI} and @var{ARCH} using
1906 the @option{--help} option.
1908 For VAX, you can specify function entry addresses with @option{-M
1909 entry:0xf00ba}. You can use this multiple times to properly
1910 disassemble VAX binary files that don't contain symbol tables (like
1911 ROM dumps). In these cases, the function entry mask would otherwise
1912 be decoded as VAX instructions, which would probably lead the rest
1913 of the function being wrongly disassembled.
1916 @itemx --private-headers
1917 Print information that is specific to the object file format. The exact
1918 information printed depends upon the object file format. For some
1919 object file formats, no additional information is printed.
1923 @cindex relocation entries, in object file
1924 Print the relocation entries of the file. If used with @option{-d} or
1925 @option{-D}, the relocations are printed interspersed with the
1929 @itemx --dynamic-reloc
1930 @cindex dynamic relocation entries, in object file
1931 Print the dynamic relocation entries of the file. This is only
1932 meaningful for dynamic objects, such as certain types of shared
1933 libraries. As for @option{-r}, if used with @option{-d} or
1934 @option{-D}, the relocations are printed interspersed with the
1938 @itemx --full-contents
1939 @cindex sections, full contents
1940 @cindex object file sections
1941 Display the full contents of any sections requested. By default all
1942 non-empty sections are displayed.
1946 @cindex source disassembly
1947 @cindex disassembly, with source
1948 Display source code intermixed with disassembly, if possible. Implies
1951 @item --prefix=@var{prefix}
1952 @cindex Add prefix to absolute paths
1953 Specify @var{prefix} to add to the absolute paths when used with
1956 @item --prefix-strip=@var{level}
1957 @cindex Strip absolute paths
1958 Indicate how many initial directory names to strip off the hardwired
1959 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
1961 @item --show-raw-insn
1962 When disassembling instructions, print the instruction in hex as well as
1963 in symbolic form. This is the default except when
1964 @option{--prefix-addresses} is used.
1966 @item --no-show-raw-insn
1967 When disassembling instructions, do not print the instruction bytes.
1968 This is the default when @option{--prefix-addresses} is used.
1970 @item -W[lLiaprmfFsoR]
1971 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
1973 @cindex debug symbols
1974 Displays the contents of the debug sections in the file, if any are
1975 present. If one of the optional letters or words follows the switch
1976 then only data found in those specific sections will be dumped.
1982 @cindex debug symbols
1983 @cindex ELF object file format
1984 Display the full contents of any sections requested. Display the
1985 contents of the .stab and .stab.index and .stab.excl sections from an
1986 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1987 @code{.stab} debugging symbol-table entries are carried in an ELF
1988 section. In most other file formats, debugging symbol-table entries are
1989 interleaved with linkage symbols, and are visible in the @option{--syms}
1992 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1993 Overview,stabs.info, The ``stabs'' debug format}.
1996 @item --start-address=@var{address}
1997 @cindex start-address
1998 Start displaying data at the specified address. This affects the output
1999 of the @option{-d}, @option{-r} and @option{-s} options.
2001 @item --stop-address=@var{address}
2002 @cindex stop-address
2003 Stop displaying data at the specified address. This affects the output
2004 of the @option{-d}, @option{-r} and @option{-s} options.
2008 @cindex symbol table entries, printing
2009 Print the symbol table entries of the file.
2010 This is similar to the information provided by the @samp{nm} program,
2011 although the display format is different. The format of the output
2012 depends upon the format of the file being dumped, but there are two main
2013 types. One looks like this:
2016 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2017 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2020 where the number inside the square brackets is the number of the entry
2021 in the symbol table, the @var{sec} number is the section number, the
2022 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2023 symbol's type, the @var{scl} number is the symbol's storage class and
2024 the @var{nx} value is the number of auxilary entries associated with
2025 the symbol. The last two fields are the symbol's value and its name.
2027 The other common output format, usually seen with ELF based files,
2031 00000000 l d .bss 00000000 .bss
2032 00000000 g .text 00000000 fred
2035 Here the first number is the symbol's value (sometimes refered to as
2036 its address). The next field is actually a set of characters and
2037 spaces indicating the flag bits that are set on the symbol. These
2038 characters are described below. Next is the section with which the
2039 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2040 not connected with any section), or @emph{*UND*} if the section is
2041 referenced in the file being dumped, but not defined there.
2043 After the section name comes another field, a number, which for common
2044 symbols is the alignment and for other symbol is the size. Finally
2045 the symbol's name is displayed.
2047 The flag characters are divided into 7 groups as follows:
2052 The symbol is local (l), global (g), neither (a space) or both (!). A
2053 symbol can be neither local or global for a variety of reasons, e.g.,
2054 because it is used for debugging, but it is probably an indication of
2055 a bug if it is ever both local and global.
2058 The symbol is weak (w) or strong (a space).
2061 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2064 The symbol is a warning (W) or a normal symbol (a space). A warning
2065 symbol's name is a message to be displayed if the symbol following the
2066 warning symbol is ever referenced.
2070 The symbol is an indirect reference to another symbol (I), a function
2071 to be evaluated during reloc processing (i) or a normal symbol (a
2076 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2077 normal symbol (a space).
2082 The symbol is the name of a function (F) or a file (f) or an object
2083 (O) or just a normal symbol (a space).
2087 @itemx --dynamic-syms
2088 @cindex dynamic symbol table entries, printing
2089 Print the dynamic symbol table entries of the file. This is only
2090 meaningful for dynamic objects, such as certain types of shared
2091 libraries. This is similar to the information provided by the @samp{nm}
2092 program when given the @option{-D} (@option{--dynamic}) option.
2094 @item --special-syms
2095 When displaying symbols include those which the target considers to be
2096 special in some way and which would not normally be of interest to the
2101 Print the version number of @command{objdump} and exit.
2104 @itemx --all-headers
2105 @cindex all header information, object file
2106 @cindex header information, all
2107 Display all available header information, including the symbol table and
2108 relocation entries. Using @option{-x} is equivalent to specifying all of
2109 @option{-a -f -h -p -r -t}.
2113 @cindex wide output, printing
2114 Format some lines for output devices that have more than 80 columns.
2115 Also do not truncate symbol names when they are displayed.
2118 @itemx --disassemble-zeroes
2119 Normally the disassembly output will skip blocks of zeroes. This
2120 option directs the disassembler to disassemble those blocks, just like
2127 @c man begin SEEALSO objdump
2128 nm(1), readelf(1), and the Info entries for @file{binutils}.
2136 @cindex archive contents
2137 @cindex symbol index
2139 @c man title ranlib generate index to archive.
2142 @c man begin SYNOPSIS ranlib
2143 ranlib [@option{-vVt}] @var{archive}
2147 @c man begin DESCRIPTION ranlib
2149 @command{ranlib} generates an index to the contents of an archive and
2150 stores it in the archive. The index lists each symbol defined by a
2151 member of an archive that is a relocatable object file.
2153 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2155 An archive with such an index speeds up linking to the library and
2156 allows routines in the library to call each other without regard to
2157 their placement in the archive.
2159 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2160 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2165 @c man begin OPTIONS ranlib
2171 Show the version number of @command{ranlib}.
2174 Update the timestamp of the symbol map of an archive.
2180 @c man begin SEEALSO ranlib
2181 ar(1), nm(1), and the Info entries for @file{binutils}.
2189 @cindex section sizes
2191 @c man title size list section sizes and total size.
2194 @c man begin SYNOPSIS size
2195 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2197 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2199 [@option{-t}|@option{--totals}]
2200 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2201 [@var{objfile}@dots{}]
2205 @c man begin DESCRIPTION size
2207 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2208 size---for each of the object or archive files @var{objfile} in its
2209 argument list. By default, one line of output is generated for each
2210 object file or each module in an archive.
2212 @var{objfile}@dots{} are the object files to be examined.
2213 If none are specified, the file @code{a.out} will be used.
2217 @c man begin OPTIONS size
2219 The command line options have the following meanings:
2224 @itemx --format=@var{compatibility}
2225 @cindex @command{size} display format
2226 Using one of these options, you can choose whether the output from @sc{gnu}
2227 @command{size} resembles output from System V @command{size} (using @option{-A},
2228 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2229 @option{--format=berkeley}). The default is the one-line format similar to
2231 @c Bonus for doc-source readers: you can also say --format=strange (or
2232 @c anything else that starts with 's') for sysv, and --format=boring (or
2233 @c anything else that starts with 'b') for Berkeley.
2235 Here is an example of the Berkeley (default) format of output from
2238 $ size --format=Berkeley ranlib size
2239 text data bss dec hex filename
2240 294880 81920 11592 388392 5ed28 ranlib
2241 294880 81920 11888 388688 5ee50 size
2245 This is the same data, but displayed closer to System V conventions:
2248 $ size --format=SysV ranlib size
2266 Show a summary of acceptable arguments and options.
2271 @itemx --radix=@var{number}
2272 @cindex @command{size} number format
2273 @cindex radix for section sizes
2274 Using one of these options, you can control whether the size of each
2275 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2276 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2277 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2278 values (8, 10, 16) are supported. The total size is always given in two
2279 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2280 octal and hexadecimal if you're using @option{-o}.
2283 Print total size of common symbols in each file. When using Berkeley
2284 format these are included in the bss size.
2288 Show totals of all objects listed (Berkeley format listing mode only).
2290 @item --target=@var{bfdname}
2291 @cindex object code format
2292 Specify that the object-code format for @var{objfile} is
2293 @var{bfdname}. This option may not be necessary; @command{size} can
2294 automatically recognize many formats.
2295 @xref{Target Selection}, for more information.
2299 Display the version number of @command{size}.
2305 @c man begin SEEALSO size
2306 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2313 @cindex listings strings
2314 @cindex printing strings
2315 @cindex strings, printing
2317 @c man title strings print the strings of printable characters in files.
2320 @c man begin SYNOPSIS strings
2321 strings [@option{-afov}] [@option{-}@var{min-len}]
2322 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2323 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2324 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2325 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2326 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2327 [@option{--help}] [@option{--version}] @var{file}@dots{}
2331 @c man begin DESCRIPTION strings
2333 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2334 character sequences that are at least 4 characters long (or the number
2335 given with the options below) and are followed by an unprintable
2336 character. By default, it only prints the strings from the initialized
2337 and loaded sections of object files; for other types of files, it prints
2338 the strings from the whole file.
2340 @command{strings} is mainly useful for determining the contents of non-text
2345 @c man begin OPTIONS strings
2351 Do not scan only the initialized and loaded sections of object files;
2352 scan the whole files.
2355 @itemx --print-file-name
2356 Print the name of the file before each string.
2359 Print a summary of the program usage on the standard output and exit.
2361 @item -@var{min-len}
2362 @itemx -n @var{min-len}
2363 @itemx --bytes=@var{min-len}
2364 Print sequences of characters that are at least @var{min-len} characters
2365 long, instead of the default 4.
2368 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2369 act like @samp{-t d} instead. Since we can not be compatible with both
2370 ways, we simply chose one.
2372 @item -t @var{radix}
2373 @itemx --radix=@var{radix}
2374 Print the offset within the file before each string. The single
2375 character argument specifies the radix of the offset---@samp{o} for
2376 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2378 @item -e @var{encoding}
2379 @itemx --encoding=@var{encoding}
2380 Select the character encoding of the strings that are to be found.
2381 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2382 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2383 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2384 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2385 littleendian. Useful for finding wide character strings. (@samp{l}
2386 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2388 @item -T @var{bfdname}
2389 @itemx --target=@var{bfdname}
2390 @cindex object code format
2391 Specify an object code format other than your system's default format.
2392 @xref{Target Selection}, for more information.
2396 Print the program version number on the standard output and exit.
2402 @c man begin SEEALSO strings
2403 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2404 and the Info entries for @file{binutils}.
2412 @cindex removing symbols
2413 @cindex discarding symbols
2414 @cindex symbols, discarding
2416 @c man title strip Discard symbols from object files.
2419 @c man begin SYNOPSIS strip
2420 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2421 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2422 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2423 [@option{-s}|@option{--strip-all}]
2424 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2425 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2426 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2427 [@option{-w}|@option{--wildcard}]
2428 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2429 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2430 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2431 [@option{--keep-file-symbols}]
2432 [@option{--only-keep-debug}]
2433 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2434 [@option{--help}] [@option{--info}]
2435 @var{objfile}@dots{}
2439 @c man begin DESCRIPTION strip
2441 @sc{gnu} @command{strip} discards all symbols from object files
2442 @var{objfile}. The list of object files may include archives.
2443 At least one object file must be given.
2445 @command{strip} modifies the files named in its argument,
2446 rather than writing modified copies under different names.
2450 @c man begin OPTIONS strip
2453 @item -F @var{bfdname}
2454 @itemx --target=@var{bfdname}
2455 Treat the original @var{objfile} as a file with the object
2456 code format @var{bfdname}, and rewrite it in the same format.
2457 @xref{Target Selection}, for more information.
2460 Show a summary of the options to @command{strip} and exit.
2463 Display a list showing all architectures and object formats available.
2465 @item -I @var{bfdname}
2466 @itemx --input-target=@var{bfdname}
2467 Treat the original @var{objfile} as a file with the object
2468 code format @var{bfdname}.
2469 @xref{Target Selection}, for more information.
2471 @item -O @var{bfdname}
2472 @itemx --output-target=@var{bfdname}
2473 Replace @var{objfile} with a file in the output format @var{bfdname}.
2474 @xref{Target Selection}, for more information.
2476 @item -R @var{sectionname}
2477 @itemx --remove-section=@var{sectionname}
2478 Remove any section named @var{sectionname} from the output file. This
2479 option may be given more than once. Note that using this option
2480 inappropriately may make the output file unusable.
2489 @itemx --strip-debug
2490 Remove debugging symbols only.
2492 @item --strip-unneeded
2493 Remove all symbols that are not needed for relocation processing.
2495 @item -K @var{symbolname}
2496 @itemx --keep-symbol=@var{symbolname}
2497 When stripping symbols, keep symbol @var{symbolname} even if it would
2498 normally be stripped. This option may be given more than once.
2500 @item -N @var{symbolname}
2501 @itemx --strip-symbol=@var{symbolname}
2502 Remove symbol @var{symbolname} from the source file. This option may be
2503 given more than once, and may be combined with strip options other than
2507 Put the stripped output in @var{file}, rather than replacing the
2508 existing file. When this argument is used, only one @var{objfile}
2509 argument may be specified.
2512 @itemx --preserve-dates
2513 Preserve the access and modification dates of the file.
2517 Permit regular expressions in @var{symbolname}s used in other command
2518 line options. The question mark (?), asterisk (*), backslash (\) and
2519 square brackets ([]) operators can be used anywhere in the symbol
2520 name. If the first character of the symbol name is the exclamation
2521 point (!) then the sense of the switch is reversed for that symbol.
2528 would cause strip to only keep symbols that start with the letters
2529 ``fo'', but to discard the symbol ``foo''.
2532 @itemx --discard-all
2533 Remove non-global symbols.
2536 @itemx --discard-locals
2537 Remove compiler-generated local symbols.
2538 (These usually start with @samp{L} or @samp{.}.)
2540 @item --keep-file-symbols
2541 When stripping a file, perhaps with @option{--strip-debug} or
2542 @option{--strip-unneeded}, retain any symbols specifying source file names,
2543 which would otherwise get stripped.
2545 @item --only-keep-debug
2546 Strip a file, removing contents of any sections that would not be
2547 stripped by @option{--strip-debug} and leaving the debugging sections
2548 intact. In ELF files, this preserves all note sections in the output.
2550 The intention is that this option will be used in conjunction with
2551 @option{--add-gnu-debuglink} to create a two part executable. One a
2552 stripped binary which will occupy less space in RAM and in a
2553 distribution and the second a debugging information file which is only
2554 needed if debugging abilities are required. The suggested procedure
2555 to create these files is as follows:
2558 @item Link the executable as normal. Assuming that is is called
2560 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2561 create a file containing the debugging info.
2562 @item Run @code{objcopy --strip-debug foo} to create a
2563 stripped executable.
2564 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2565 to add a link to the debugging info into the stripped executable.
2568 Note---the choice of @code{.dbg} as an extension for the debug info
2569 file is arbitrary. Also the @code{--only-keep-debug} step is
2570 optional. You could instead do this:
2573 @item Link the executable as normal.
2574 @item Copy @code{foo} to @code{foo.full}
2575 @item Run @code{strip --strip-debug foo}
2576 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2579 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2580 full executable. It does not have to be a file created by the
2581 @option{--only-keep-debug} switch.
2583 Note---this switch is only intended for use on fully linked files. It
2584 does not make sense to use it on object files where the debugging
2585 information may be incomplete. Besides the gnu_debuglink feature
2586 currently only supports the presence of one filename containing
2587 debugging information, not multiple filenames on a one-per-object-file
2592 Show the version number for @command{strip}.
2596 Verbose output: list all object files modified. In the case of
2597 archives, @samp{strip -v} lists all members of the archive.
2603 @c man begin SEEALSO strip
2604 the Info entries for @file{binutils}.
2608 @node c++filt, addr2line, strip, Top
2612 @cindex demangling C++ symbols
2614 @c man title cxxfilt Demangle C++ and Java symbols.
2617 @c man begin SYNOPSIS cxxfilt
2618 c++filt [@option{-_}|@option{--strip-underscores}]
2619 [@option{-n}|@option{--no-strip-underscores}]
2620 [@option{-p}|@option{--no-params}]
2621 [@option{-t}|@option{--types}]
2622 [@option{-i}|@option{--no-verbose}]
2623 [@option{-s} @var{format}|@option{--format=}@var{format}]
2624 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2628 @c man begin DESCRIPTION cxxfilt
2631 The C++ and Java languages provide function overloading, which means
2632 that you can write many functions with the same name, providing that
2633 each function takes parameters of different types. In order to be
2634 able to distinguish these similarly named functions C++ and Java
2635 encode them into a low-level assembler name which uniquely identifies
2636 each different version. This process is known as @dfn{mangling}. The
2638 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2639 MS-DOS this program is named @command{CXXFILT}.}
2640 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2641 names into user-level names so that they can be read.
2643 Every alphanumeric word (consisting of letters, digits, underscores,
2644 dollars, or periods) seen in the input is a potential mangled name.
2645 If the name decodes into a C++ name, the C++ name replaces the
2646 low-level name in the output, otherwise the original word is output.
2647 In this way you can pass an entire assembler source file, containing
2648 mangled names, through @command{c++filt} and see the same source file
2649 containing demangled names.
2651 You can also use @command{c++filt} to decipher individual symbols by
2652 passing them on the command line:
2655 c++filt @var{symbol}
2658 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2659 names from the standard input instead. All the results are printed on
2660 the standard output. The difference between reading names from the
2661 command line versus reading names from the standard input is that
2662 command line arguments are expected to be just mangled names and no
2663 checking is performed to separate them from surrounding text. Thus
2670 will work and demangle the name to ``f()'' whereas:
2676 will not work. (Note the extra comma at the end of the mangled
2677 name which makes it invalid). This command however will work:
2680 echo _Z1fv, | c++filt -n
2683 and will display ``f(),'', i.e., the demangled name followed by a
2684 trailing comma. This behaviour is because when the names are read
2685 from the standard input it is expected that they might be part of an
2686 assembler source file where there might be extra, extraneous
2687 characters trailing after a mangled name. For example:
2690 .type _Z1fv, @@function
2695 @c man begin OPTIONS cxxfilt
2699 @itemx --strip-underscores
2700 On some systems, both the C and C++ compilers put an underscore in front
2701 of every name. For example, the C name @code{foo} gets the low-level
2702 name @code{_foo}. This option removes the initial underscore. Whether
2703 @command{c++filt} removes the underscore by default is target dependent.
2707 Prints demangled names using Java syntax. The default is to use C++
2711 @itemx --no-strip-underscores
2712 Do not remove the initial underscore.
2716 When demangling the name of a function, do not display the types of
2717 the function's parameters.
2721 Attempt to demangle types as well as function names. This is disabled
2722 by default since mangled types are normally only used internally in
2723 the compiler, and they can be confused with non-mangled names. For example,
2724 a function called ``a'' treated as a mangled type name would be
2725 demangled to ``signed char''.
2729 Do not include implementation details (if any) in the demangled
2732 @item -s @var{format}
2733 @itemx --format=@var{format}
2734 @command{c++filt} can decode various methods of mangling, used by
2735 different compilers. The argument to this option selects which
2740 Automatic selection based on executable (the default method)
2742 the one used by the @sc{gnu} C++ compiler (g++)
2744 the one used by the Lucid compiler (lcc)
2746 the one specified by the C++ Annotated Reference Manual
2748 the one used by the HP compiler (aCC)
2750 the one used by the EDG compiler
2752 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2754 the one used by the @sc{gnu} Java compiler (gcj)
2756 the one used by the @sc{gnu} Ada compiler (GNAT).
2760 Print a summary of the options to @command{c++filt} and exit.
2763 Print the version number of @command{c++filt} and exit.
2769 @c man begin SEEALSO cxxfilt
2770 the Info entries for @file{binutils}.
2775 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2776 user interface are subject to change in future releases. In particular,
2777 a command-line option may be required in the future to decode a name
2778 passed as an argument on the command line; in other words,
2781 c++filt @var{symbol}
2785 may in a future release become
2788 c++filt @var{option} @var{symbol}
2796 @cindex address to file name and line number
2798 @c man title addr2line convert addresses into file names and line numbers.
2801 @c man begin SYNOPSIS addr2line
2802 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2803 [@option{-C}|@option{--demangle}[=@var{style}]]
2804 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2805 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2806 [@option{-i}|@option{--inlines}]
2807 [@option{-j}|@option{--section=}@var{name}]
2808 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2813 @c man begin DESCRIPTION addr2line
2815 @command{addr2line} translates addresses into file names and line numbers.
2816 Given an address in an executable or an offset in a section of a relocatable
2817 object, it uses the debugging information to figure out which file name and
2818 line number are associated with it.
2820 The executable or relocatable object to use is specified with the @option{-e}
2821 option. The default is the file @file{a.out}. The section in the relocatable
2822 object to use is specified with the @option{-j} option.
2824 @command{addr2line} has two modes of operation.
2826 In the first, hexadecimal addresses are specified on the command line,
2827 and @command{addr2line} displays the file name and line number for each
2830 In the second, @command{addr2line} reads hexadecimal addresses from
2831 standard input, and prints the file name and line number for each
2832 address on standard output. In this mode, @command{addr2line} may be used
2833 in a pipe to convert dynamically chosen addresses.
2835 The format of the output is @samp{FILENAME:LINENO}. The file name and
2836 line number for each address is printed on a separate line. If the
2837 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2838 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2839 containing the address.
2841 If the file name or function name can not be determined,
2842 @command{addr2line} will print two question marks in their place. If the
2843 line number can not be determined, @command{addr2line} will print 0.
2847 @c man begin OPTIONS addr2line
2849 The long and short forms of options, shown here as alternatives, are
2853 @item -b @var{bfdname}
2854 @itemx --target=@var{bfdname}
2855 @cindex object code format
2856 Specify that the object-code format for the object files is
2860 @itemx --demangle[=@var{style}]
2861 @cindex demangling in objdump
2862 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2863 Besides removing any initial underscore prepended by the system, this
2864 makes C++ function names readable. Different compilers have different
2865 mangling styles. The optional demangling style argument can be used to
2866 choose an appropriate demangling style for your compiler. @xref{c++filt},
2867 for more information on demangling.
2869 @item -e @var{filename}
2870 @itemx --exe=@var{filename}
2871 Specify the name of the executable for which addresses should be
2872 translated. The default file is @file{a.out}.
2876 Display function names as well as file and line number information.
2880 Display only the base of each file name.
2884 If the address belongs to a function that was inlined, the source
2885 information for all enclosing scopes back to the first non-inlined
2886 function will also be printed. For example, if @code{main} inlines
2887 @code{callee1} which inlines @code{callee2}, and address is from
2888 @code{callee2}, the source information for @code{callee1} and @code{main}
2889 will also be printed.
2893 Read offsets relative to the specified section instead of absolute addresses.
2899 @c man begin SEEALSO addr2line
2900 Info entries for @file{binutils}.
2907 @command{nlmconv} converts a relocatable object file into a NetWare
2911 @command{nlmconv} currently works with @samp{i386} object
2912 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2913 object files in @sc{elf}, or @code{a.out} format@footnote{
2914 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2915 format in the Binary File Descriptor library. It has only been tested
2916 with the above formats.}.
2920 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2921 utilities, since it is only useful for NLM targets.
2924 @c man title nlmconv converts object code into an NLM.
2927 @c man begin SYNOPSIS nlmconv
2928 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2929 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2930 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2931 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2932 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2933 @var{infile} @var{outfile}
2937 @c man begin DESCRIPTION nlmconv
2939 @command{nlmconv} converts the relocatable @samp{i386} object file
2940 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2941 reading @var{headerfile} for NLM header information. For instructions
2942 on writing the NLM command file language used in header files, see the
2943 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2944 Development and Tools Overview}, which is part of the NLM Software
2945 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2946 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2949 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2952 @command{nlmconv} can perform a link step. In other words, you can list
2953 more than one object file for input if you list them in the definitions
2954 file (rather than simply specifying one input file on the command line).
2955 In this case, @command{nlmconv} calls the linker for you.
2959 @c man begin OPTIONS nlmconv
2962 @item -I @var{bfdname}
2963 @itemx --input-target=@var{bfdname}
2964 Object format of the input file. @command{nlmconv} can usually determine
2965 the format of a given file (so no default is necessary).
2966 @xref{Target Selection}, for more information.
2968 @item -O @var{bfdname}
2969 @itemx --output-target=@var{bfdname}
2970 Object format of the output file. @command{nlmconv} infers the output
2971 format based on the input format, e.g. for a @samp{i386} input file the
2972 output format is @samp{nlm32-i386}.
2973 @xref{Target Selection}, for more information.
2975 @item -T @var{headerfile}
2976 @itemx --header-file=@var{headerfile}
2977 Reads @var{headerfile} for NLM header information. For instructions on
2978 writing the NLM command file language used in header files, see@ see the
2979 @samp{linkers} section, of the @cite{NLM Development and Tools
2980 Overview}, which is part of the NLM Software Developer's Kit, available
2985 Displays (on standard error) the linker command line used by @command{nlmconv}.
2987 @item -l @var{linker}
2988 @itemx --linker=@var{linker}
2989 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2994 Prints a usage summary.
2998 Prints the version number for @command{nlmconv}.
3004 @c man begin SEEALSO nlmconv
3005 the Info entries for @file{binutils}.
3012 @command{windmc} may be used to generator Windows message resources.
3015 @emph{Warning:} @command{windmc} is not always built as part of the binary
3016 utilities, since it is only useful for Windows targets.
3019 @c man title windmc generates Windows message resources.
3022 @c man begin SYNOPSIS windres
3023 windmc [options] input-file
3027 @c man begin DESCRIPTION windmc
3029 @command{windmc} reads message definitions from an input file (.mc) and
3030 translate them into a set of output files. The output files may be of
3035 A C header file containing the message definitions.
3038 A resource file compilable by the @command{windres} tool.
3041 One or more binary files containing the resource data for a specific
3045 A C include file that maps message id's to their symbolic name.
3048 The exact description of these different formats is available in
3049 documentation from Microsoft.
3051 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3052 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3053 Windows Message Compiler.
3057 @c man begin OPTIONS windmc
3062 Specifies that the input file specified is ANSI. This is the default
3067 Specifies that messages in the output @code{bin} files should be in ANSI
3072 Specifies that @code{bin} filenames should have to be prefixed by the
3073 basename of the source file.
3077 Sets the customer bit in all message id's.
3079 @item -C @var{codepage}
3080 @itemx --codepage_in @var{codepage}
3081 Sets the default codepage to be used to convert input file to UTF16. The
3082 default is ocdepage 1252.
3085 @itemx --decimal_values
3086 Outputs the constants in the header file in decimal. Default is using
3090 @itemx --extension @var{ext}
3091 The extension for the header file. The default is .h extension.
3093 @item -F @var{target}
3094 @itemx --target @var{target}
3095 Specify the BFD format to use for a bin file as output. This
3096 is a BFD target name; you can use the @option{--help} option to see a list
3097 of supported targets. Normally @command{windmc} will use the default
3098 format, which is the first one listed by the @option{--help} option.
3100 @ref{Target Selection}.
3104 @itemx --headerdir @var{path}
3105 The target directory of the generated header file. The default is the
3110 Displays a list of command line options and then exits.
3112 @item -m @var{characters}
3113 @itemx --maxlength @var{characters}
3114 Instructs @command{windmc} to generate a warning if the length
3115 of any message exceeds the number specified.
3118 @itemx --nullterminate
3119 Terminate message text in @code{bin} files by zero. By default they are
3120 terminated by CR/LF.
3123 @itemx --hresult_use
3124 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3125 file, using HRESULT definitions. Status codes are used if the flag is not
3128 @item -O @var{codepage}
3129 @itemx --codepage_out @var{codepage}
3130 Sets the default codepage to be used to output text files. The default
3134 @itemx --rcdir @var{path}
3135 The target directory for the generated @code{rc} script and the generated
3136 @code{bin} files that the resource compiler script includes. The default
3137 is the current directory.
3141 Specifies that the input file is UTF16.
3144 @itemx --unicode_out
3145 Specifies that messages in the output @code{bin} file should be in UTF16
3146 format. This is the default behaviour.
3150 Enable verbose mode.
3154 Prints the version number for @command{windmc}.
3157 @itemx --xdgb @var{path}
3158 The path of the @code{dbg} C include file that maps message id's to the
3159 symbolic name. No such file is generated without specifying the switch.
3165 @c man begin SEEALSO windmc
3166 the Info entries for @file{binutils}.
3173 @command{windres} may be used to manipulate Windows resources.
3176 @emph{Warning:} @command{windres} is not always built as part of the binary
3177 utilities, since it is only useful for Windows targets.
3180 @c man title windres manipulate Windows resources.
3183 @c man begin SYNOPSIS windres
3184 windres [options] [input-file] [output-file]
3188 @c man begin DESCRIPTION windres
3190 @command{windres} reads resources from an input file and copies them into
3191 an output file. Either file may be in one of three formats:
3195 A text format read by the Resource Compiler.
3198 A binary format generated by the Resource Compiler.
3201 A COFF object or executable.
3204 The exact description of these different formats is available in
3205 documentation from Microsoft.
3207 When @command{windres} converts from the @code{rc} format to the @code{res}
3208 format, it is acting like the Windows Resource Compiler. When
3209 @command{windres} converts from the @code{res} format to the @code{coff}
3210 format, it is acting like the Windows @code{CVTRES} program.
3212 When @command{windres} generates an @code{rc} file, the output is similar
3213 but not identical to the format expected for the input. When an input
3214 @code{rc} file refers to an external filename, an output @code{rc} file
3215 will instead include the file contents.
3217 If the input or output format is not specified, @command{windres} will
3218 guess based on the file name, or, for the input file, the file contents.
3219 A file with an extension of @file{.rc} will be treated as an @code{rc}
3220 file, a file with an extension of @file{.res} will be treated as a
3221 @code{res} file, and a file with an extension of @file{.o} or
3222 @file{.exe} will be treated as a @code{coff} file.
3224 If no output file is specified, @command{windres} will print the resources
3225 in @code{rc} format to standard output.
3227 The normal use is for you to write an @code{rc} file, use @command{windres}
3228 to convert it to a COFF object file, and then link the COFF file into
3229 your application. This will make the resources described in the
3230 @code{rc} file available to Windows.
3234 @c man begin OPTIONS windres
3237 @item -i @var{filename}
3238 @itemx --input @var{filename}
3239 The name of the input file. If this option is not used, then
3240 @command{windres} will use the first non-option argument as the input file
3241 name. If there are no non-option arguments, then @command{windres} will
3242 read from standard input. @command{windres} can not read a COFF file from
3245 @item -o @var{filename}
3246 @itemx --output @var{filename}
3247 The name of the output file. If this option is not used, then
3248 @command{windres} will use the first non-option argument, after any used
3249 for the input file name, as the output file name. If there is no
3250 non-option argument, then @command{windres} will write to standard output.
3251 @command{windres} can not write a COFF file to standard output. Note,
3252 for compatibility with @command{rc} the option @option{-fo} is also
3253 accepted, but its use is not recommended.
3255 @item -J @var{format}
3256 @itemx --input-format @var{format}
3257 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3258 @samp{coff}. If no input format is specified, @command{windres} will
3259 guess, as described above.
3261 @item -O @var{format}
3262 @itemx --output-format @var{format}
3263 The output format to generate. @var{format} may be @samp{res},
3264 @samp{rc}, or @samp{coff}. If no output format is specified,
3265 @command{windres} will guess, as described above.
3267 @item -F @var{target}
3268 @itemx --target @var{target}
3269 Specify the BFD format to use for a COFF file as input or output. This
3270 is a BFD target name; you can use the @option{--help} option to see a list
3271 of supported targets. Normally @command{windres} will use the default
3272 format, which is the first one listed by the @option{--help} option.
3274 @ref{Target Selection}.
3277 @item --preprocessor @var{program}
3278 When @command{windres} reads an @code{rc} file, it runs it through the C
3279 preprocessor first. This option may be used to specify the preprocessor
3280 to use, including any leading arguments. The default preprocessor
3281 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3283 @item -I @var{directory}
3284 @itemx --include-dir @var{directory}
3285 Specify an include directory to use when reading an @code{rc} file.
3286 @command{windres} will pass this to the preprocessor as an @option{-I}
3287 option. @command{windres} will also search this directory when looking for
3288 files named in the @code{rc} file. If the argument passed to this command
3289 matches any of the supported @var{formats} (as described in the @option{-J}
3290 option), it will issue a deprecation warning, and behave just like the
3291 @option{-J} option. New programs should not use this behaviour. If a
3292 directory happens to match a @var{format}, simple prefix it with @samp{./}
3293 to disable the backward compatibility.
3295 @item -D @var{target}
3296 @itemx --define @var{sym}[=@var{val}]
3297 Specify a @option{-D} option to pass to the preprocessor when reading an
3300 @item -U @var{target}
3301 @itemx --undefine @var{sym}
3302 Specify a @option{-U} option to pass to the preprocessor when reading an
3306 Ignored for compatibility with rc.
3309 Enable verbose mode. This tells you what the preprocessor is if you
3313 @item --codepage @var{val}
3314 Specify the default codepage to use when reading an @code{rc} file.
3315 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3316 codepage code. The valid range is from zero up to 0xffff, but the
3317 validity of the codepage is host and configuration dependent.
3320 @item --language @var{val}
3321 Specify the default language to use when reading an @code{rc} file.
3322 @var{val} should be a hexadecimal language code. The low eight bits are
3323 the language, and the high eight bits are the sublanguage.
3325 @item --use-temp-file
3326 Use a temporary file to instead of using popen to read the output of
3327 the preprocessor. Use this option if the popen implementation is buggy
3328 on the host (eg., certain non-English language versions of Windows 95 and
3329 Windows 98 are known to have buggy popen where the output will instead
3332 @item --no-use-temp-file
3333 Use popen, not a temporary file, to read the output of the preprocessor.
3334 This is the default behaviour.
3338 Prints a usage summary.
3342 Prints the version number for @command{windres}.
3345 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3346 this will turn on parser debugging.
3352 @c man begin SEEALSO windres
3353 the Info entries for @file{binutils}.
3362 @command{dlltool} is used to create the files needed to create dynamic
3363 link libraries (DLLs) on systems which understand PE format image
3364 files such as Windows. A DLL contains an export table which contains
3365 information that the runtime loader needs to resolve references from a
3366 referencing program.
3368 The export table is generated by this program by reading in a
3369 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3370 will be in the DLL. A @file{.o} file can contain information in
3371 special @samp{.drectve} sections with export information.
3374 @emph{Note:} @command{dlltool} is not always built as part of the
3375 binary utilities, since it is only useful for those targets which
3379 @c man title dlltool Create files needed to build and use DLLs.
3382 @c man begin SYNOPSIS dlltool
3383 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3384 [@option{-b}|@option{--base-file} @var{base-file-name}]
3385 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3386 [@option{-z}|@option{--output-def} @var{def-file-name}]
3387 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3388 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3389 [@option{--exclude-symbols} @var{list}]
3390 [@option{--no-default-excludes}]
3391 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3392 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3393 [@option{-a}|@option{--add-indirect}]
3394 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3395 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3396 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3397 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3398 [@option{--use-nul-prefixed-import-tables}]
3399 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3400 [@option{-i}|@option{--interwork}]
3401 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3402 [@option{-v}|@option{--verbose}]
3403 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3404 [object-file @dots{}]
3408 @c man begin DESCRIPTION dlltool
3410 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3411 @option{-b} options as well as object files specified on the command
3412 line. It then processes these inputs and if the @option{-e} option has
3413 been specified it creates a exports file. If the @option{-l} option
3414 has been specified it creates a library file and if the @option{-z} option
3415 has been specified it creates a def file. Any or all of the @option{-e},
3416 @option{-l} and @option{-z} options can be present in one invocation of
3419 When creating a DLL, along with the source for the DLL, it is necessary
3420 to have three other files. @command{dlltool} can help with the creation of
3423 The first file is a @file{.def} file which specifies which functions are
3424 exported from the DLL, which functions the DLL imports, and so on. This
3425 is a text file and can be created by hand, or @command{dlltool} can be used
3426 to create it using the @option{-z} option. In this case @command{dlltool}
3427 will scan the object files specified on its command line looking for
3428 those functions which have been specially marked as being exported and
3429 put entries for them in the @file{.def} file it creates.
3431 In order to mark a function as being exported from a DLL, it needs to
3432 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3433 section of the object file. This can be done in C by using the
3437 asm (".section .drectve");
3438 asm (".ascii \"-export:my_func\"");
3440 int my_func (void) @{ @dots{} @}
3443 The second file needed for DLL creation is an exports file. This file
3444 is linked with the object files that make up the body of the DLL and it
3445 handles the interface between the DLL and the outside world. This is a
3446 binary file and it can be created by giving the @option{-e} option to
3447 @command{dlltool} when it is creating or reading in a @file{.def} file.
3449 The third file needed for DLL creation is the library file that programs
3450 will link with in order to access the functions in the DLL (an `import
3451 library'). This file can be created by giving the @option{-l} option to
3452 dlltool when it is creating or reading in a @file{.def} file.
3454 @command{dlltool} builds the library file by hand, but it builds the
3455 exports file by creating temporary files containing assembler statements
3456 and then assembling these. The @option{-S} command line option can be
3457 used to specify the path to the assembler that dlltool will use,
3458 and the @option{-f} option can be used to pass specific flags to that
3459 assembler. The @option{-n} can be used to prevent dlltool from deleting
3460 these temporary assembler files when it is done, and if @option{-n} is
3461 specified twice then this will prevent dlltool from deleting the
3462 temporary object files it used to build the library.
3464 Here is an example of creating a DLL from a source file @samp{dll.c} and
3465 also creating a program (from an object file called @samp{program.o})
3470 dlltool -e exports.o -l dll.lib dll.o
3471 gcc dll.o exports.o -o dll.dll
3472 gcc program.o dll.lib -o program
3476 @command{dlltool} may also be used to query an existing import library
3477 to determine the name of the DLL to which it is associated. See the
3478 description of the @option{-I} or @option{--identify} option.
3482 @c man begin OPTIONS dlltool
3484 The command line options have the following meanings:
3488 @item -d @var{filename}
3489 @itemx --input-def @var{filename}
3490 @cindex input .def file
3491 Specifies the name of a @file{.def} file to be read in and processed.
3493 @item -b @var{filename}
3494 @itemx --base-file @var{filename}
3496 Specifies the name of a base file to be read in and processed. The
3497 contents of this file will be added to the relocation section in the
3498 exports file generated by dlltool.
3500 @item -e @var{filename}
3501 @itemx --output-exp @var{filename}
3502 Specifies the name of the export file to be created by dlltool.
3504 @item -z @var{filename}
3505 @itemx --output-def @var{filename}
3506 Specifies the name of the @file{.def} file to be created by dlltool.
3508 @item -l @var{filename}
3509 @itemx --output-lib @var{filename}
3510 Specifies the name of the library file to be created by dlltool.
3512 @item --export-all-symbols
3513 Treat all global and weak defined symbols found in the input object
3514 files as symbols to be exported. There is a small list of symbols which
3515 are not exported by default; see the @option{--no-default-excludes}
3516 option. You may add to the list of symbols to not export by using the
3517 @option{--exclude-symbols} option.
3519 @item --no-export-all-symbols
3520 Only export symbols explicitly listed in an input @file{.def} file or in
3521 @samp{.drectve} sections in the input object files. This is the default
3522 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3523 attributes in the source code.
3525 @item --exclude-symbols @var{list}
3526 Do not export the symbols in @var{list}. This is a list of symbol names
3527 separated by comma or colon characters. The symbol names should not
3528 contain a leading underscore. This is only meaningful when
3529 @option{--export-all-symbols} is used.
3531 @item --no-default-excludes
3532 When @option{--export-all-symbols} is used, it will by default avoid
3533 exporting certain special symbols. The current list of symbols to avoid
3534 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3535 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3536 to go ahead and export these special symbols. This is only meaningful
3537 when @option{--export-all-symbols} is used.
3540 @itemx --as @var{path}
3541 Specifies the path, including the filename, of the assembler to be used
3542 to create the exports file.
3544 @item -f @var{options}
3545 @itemx --as-flags @var{options}
3546 Specifies any specific command line options to be passed to the
3547 assembler when building the exports file. This option will work even if
3548 the @option{-S} option is not used. This option only takes one argument,
3549 and if it occurs more than once on the command line, then later
3550 occurrences will override earlier occurrences. So if it is necessary to
3551 pass multiple options to the assembler they should be enclosed in
3555 @itemx --dll-name @var{name}
3556 Specifies the name to be stored in the @file{.def} file as the name of
3557 the DLL when the @option{-e} option is used. If this option is not
3558 present, then the filename given to the @option{-e} option will be
3559 used as the name of the DLL.
3561 @item -m @var{machine}
3562 @itemx -machine @var{machine}
3563 Specifies the type of machine for which the library file should be
3564 built. @command{dlltool} has a built in default type, depending upon how
3565 it was created, but this option can be used to override that. This is
3566 normally only useful when creating DLLs for an ARM processor, when the
3567 contents of the DLL are actually encode using Thumb instructions.
3570 @itemx --add-indirect
3571 Specifies that when @command{dlltool} is creating the exports file it
3572 should add a section which allows the exported functions to be
3573 referenced without using the import library. Whatever the hell that
3577 @itemx --add-underscore
3578 Specifies that when @command{dlltool} is creating the exports file it
3579 should prepend an underscore to the names of @emph{all} exported symbols.
3581 @item --add-stdcall-underscore
3582 Specifies that when @command{dlltool} is creating the exports file it
3583 should prepend an underscore to the names of exported @emph{stdcall}
3584 functions. Variable names and non-stdcall function names are not modified.
3585 This option is useful when creating GNU-compatible import libs for third
3586 party DLLs that were built with MS-Windows tools.
3590 Specifies that when @command{dlltool} is creating the exports file it
3591 should not append the string @samp{@@ <number>}. These numbers are
3592 called ordinal numbers and they represent another way of accessing the
3593 function in a DLL, other than by name.
3596 @itemx --add-stdcall-alias
3597 Specifies that when @command{dlltool} is creating the exports file it
3598 should add aliases for stdcall symbols without @samp{@@ <number>}
3599 in addition to the symbols with @samp{@@ <number>}.
3602 @itemx --ext-prefix-alias @var{prefix}
3603 Causes @command{dlltool} to create external aliases for all DLL
3604 imports with the specified prefix. The aliases are created for both
3605 external and import symbols with no leading underscore.
3609 Specifies that when @command{dlltool} is creating the exports and library
3610 files it should omit the @code{.idata4} section. This is for compatibility
3611 with certain operating systems.
3613 @item --use-nul-prefixed-import-tables
3614 Specifies that when @command{dlltool} is creating the exports and library
3615 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
3616 element. This emulates old gnu import library generation of
3617 @code{dlltool}. By default this option is turned off.
3621 Specifies that when @command{dlltool} is creating the exports and library
3622 files it should omit the @code{.idata5} section. This is for compatibility
3623 with certain operating systems.
3625 @item -I @var{filename}
3626 @itemx --identify @var{filename}
3627 Specifies that @command{dlltool} should inspect the import library
3628 indicated by @var{filename} and report, on @code{stdout}, the name(s)
3629 of the associated DLL(s). This can be performed in addition to any
3630 other operations indicated by the other options and arguments.
3631 @command{dlltool} fails if the import library does not exist or is not
3632 actually an import library. See also @option{--identify-strict}.
3634 @item --identify-strict
3635 Modifies the behavior of the @option{--identify} option, such
3636 that an error is reported if @var{filename} is associated with
3641 Specifies that @command{dlltool} should mark the objects in the library
3642 file and exports file that it produces as supporting interworking
3643 between ARM and Thumb code.
3647 Makes @command{dlltool} preserve the temporary assembler files it used to
3648 create the exports file. If this option is repeated then dlltool will
3649 also preserve the temporary object files it uses to create the library
3652 @item -t @var{prefix}
3653 @itemx --temp-prefix @var{prefix}
3654 Makes @command{dlltool} use @var{prefix} when constructing the names of
3655 temporary assembler and object files. By default, the temp file prefix
3656 is generated from the pid.
3660 Make dlltool describe what it is doing.
3664 Displays a list of command line options and then exits.
3668 Displays dlltool's version number and then exits.
3675 * def file format:: The format of the dlltool @file{.def} file
3678 @node def file format
3679 @section The format of the @command{dlltool} @file{.def} file
3681 A @file{.def} file contains any number of the following commands:
3685 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3686 The result is going to be named @var{name}@code{.exe}.
3688 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3689 The result is going to be named @var{name}@code{.dll}.
3691 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3692 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3693 Declares @var{name1} as an exported symbol from the DLL, with optional
3694 ordinal number @var{integer}, or declares @var{name1} as an alias
3695 (forward) of the function @var{external-name} in the DLL
3698 @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{) ) *}
3699 Declares that @var{external-name} or the exported function whose
3700 ordinal number is @var{integer} is to be imported from the file
3701 @var{module-name}. If @var{internal-name} is specified then this is
3702 the name that the imported function will be referred to in the body of
3705 @item @code{DESCRIPTION} @var{string}
3706 Puts @var{string} into the output @file{.exp} file in the
3707 @code{.rdata} section.
3709 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3710 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3711 Generates @code{--stack} or @code{--heap}
3712 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
3713 section. The linker will see this and act upon it.
3715 @item @code{CODE} @var{attr} @code{+}
3716 @item @code{DATA} @var{attr} @code{+}
3717 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3718 Generates @code{--attr} @var{section-name} @var{attr} in the output
3719 @code{.drectve} section, where @var{attr} is one of @code{READ},
3720 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3721 this and act upon it.
3726 @c man begin SEEALSO dlltool
3727 The Info pages for @file{binutils}.
3734 @cindex ELF file information
3737 @c man title readelf Displays information about ELF files.
3740 @c man begin SYNOPSIS readelf
3741 readelf [@option{-a}|@option{--all}]
3742 [@option{-h}|@option{--file-header}]
3743 [@option{-l}|@option{--program-headers}|@option{--segments}]
3744 [@option{-S}|@option{--section-headers}|@option{--sections}]
3745 [@option{-g}|@option{--section-groups}]
3746 [@option{-t}|@option{--section-details}]
3747 [@option{-e}|@option{--headers}]
3748 [@option{-s}|@option{--syms}|@option{--symbols}]
3749 [@option{-n}|@option{--notes}]
3750 [@option{-r}|@option{--relocs}]
3751 [@option{-u}|@option{--unwind}]
3752 [@option{-d}|@option{--dynamic}]
3753 [@option{-V}|@option{--version-info}]
3754 [@option{-A}|@option{--arch-specific}]
3755 [@option{-D}|@option{--use-dynamic}]
3756 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
3757 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
3758 [@option{-c}|@option{--archive-index}]
3759 [@option{-w[lLiaprmfFsoR]}|
3760 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
3761 [@option{-I}|@option{-histogram}]
3762 [@option{-v}|@option{--version}]
3763 [@option{-W}|@option{--wide}]
3764 [@option{-H}|@option{--help}]
3765 @var{elffile}@dots{}
3769 @c man begin DESCRIPTION readelf
3771 @command{readelf} displays information about one or more ELF format object
3772 files. The options control what particular information to display.
3774 @var{elffile}@dots{} are the object files to be examined. 32-bit and
3775 64-bit ELF files are supported, as are archives containing ELF files.
3777 This program performs a similar function to @command{objdump} but it
3778 goes into more detail and it exists independently of the @sc{bfd}
3779 library, so if there is a bug in @sc{bfd} then readelf will not be
3784 @c man begin OPTIONS readelf
3786 The long and short forms of options, shown here as alternatives, are
3787 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3793 Equivalent to specifying @option{--file-header},
3794 @option{--program-headers}, @option{--sections}, @option{--symbols},
3795 @option{--relocs}, @option{--dynamic}, @option{--notes} and
3796 @option{--version-info}.
3799 @itemx --file-header
3800 @cindex ELF file header information
3801 Displays the information contained in the ELF header at the start of the
3805 @itemx --program-headers
3807 @cindex ELF program header information
3808 @cindex ELF segment information
3809 Displays the information contained in the file's segment headers, if it
3814 @itemx --section-headers
3815 @cindex ELF section information
3816 Displays the information contained in the file's section headers, if it
3820 @itemx --section-groups
3821 @cindex ELF section group information
3822 Displays the information contained in the file's section groups, if it
3826 @itemx --section-details
3827 @cindex ELF section information
3828 Displays the detailed section information. Implies @option{-S}.
3833 @cindex ELF symbol table information
3834 Displays the entries in symbol table section of the file, if it has one.
3838 Display all the headers in the file. Equivalent to @option{-h -l -S}.
3843 Displays the contents of the NOTE segments and/or sections, if any.
3847 @cindex ELF reloc information
3848 Displays the contents of the file's relocation section, if it has one.
3852 @cindex unwind information
3853 Displays the contents of the file's unwind section, if it has one. Only
3854 the unwind sections for IA64 ELF files are currently supported.
3858 @cindex ELF dynamic section information
3859 Displays the contents of the file's dynamic section, if it has one.
3862 @itemx --version-info
3863 @cindex ELF version sections informations
3864 Displays the contents of the version sections in the file, it they
3868 @itemx --arch-specific
3869 Displays architecture-specific information in the file, if there
3873 @itemx --use-dynamic
3874 When displaying symbols, this option makes @command{readelf} use the
3875 symbol table in the file's dynamic section, rather than the one in the
3878 @item -x <number or name>
3879 @itemx --hex-dump=<number or name>
3880 Displays the contents of the indicated section as a hexadecimal dump.
3881 A number identifies a particular section by index in the section table;
3882 any other string identifies all sections with that name in the object file.
3884 @item -p <number or name>
3885 @itemx --string-dump=<number or name>
3886 Displays the contents of the indicated section as printable strings.
3887 A number identifies a particular section by index in the section table;
3888 any other string identifies all sections with that name in the object file.
3891 @itemx --archive-index
3892 @cindex Archive file symbol index information
3893 Displays the file symbol index infomation contained in the header part
3894 of binary archives. Performs the same function as the @option{t}
3895 command to @command{ar}, but without using the BFD library. @xref{ar}.
3897 @item -w[lLiaprmfFsoR]
3898 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
3899 Displays the contents of the debug sections in the file, if any are
3900 present. If one of the optional letters or words follows the switch
3901 then only data found in those specific sections will be dumped.
3903 Note: the @option{=decodedline} option will display the interpreted
3904 contents of a .debug_line section whereas the @option{=rawline} option
3905 dumps the contents in a raw format.
3909 Display a histogram of bucket list lengths when displaying the contents
3910 of the symbol tables.
3914 Display the version number of readelf.
3918 Don't break output lines to fit into 80 columns. By default
3919 @command{readelf} breaks section header and segment listing lines for
3920 64-bit ELF files, so that they fit into 80 columns. This option causes
3921 @command{readelf} to print each section header resp. each segment one a
3922 single line, which is far more readable on terminals wider than 80 columns.
3926 Display the command line options understood by @command{readelf}.
3933 @c man begin SEEALSO readelf
3934 objdump(1), and the Info entries for @file{binutils}.
3938 @node Common Options
3939 @chapter Common Options
3941 The following command-line options are supported by all of the
3942 programs described in this manual.
3944 @c man begin OPTIONS
3946 @include at-file.texi
3950 Display the command-line options supported by the program.
3953 Display the version number of the program.
3955 @c man begin OPTIONS
3959 @node Selecting the Target System
3960 @chapter Selecting the Target System
3962 You can specify two aspects of the target system to the @sc{gnu}
3963 binary file utilities, each in several ways:
3973 In the following summaries, the lists of ways to specify values are in
3974 order of decreasing precedence. The ways listed first override those
3977 The commands to list valid values only list the values for which the
3978 programs you are running were configured. If they were configured with
3979 @option{--enable-targets=all}, the commands list most of the available
3980 values, but a few are left out; not all targets can be configured in at
3981 once because some of them can only be configured @dfn{native} (on hosts
3982 with the same type as the target system).
3985 * Target Selection::
3986 * Architecture Selection::
3989 @node Target Selection
3990 @section Target Selection
3992 A @dfn{target} is an object file format. A given target may be
3993 supported for multiple architectures (@pxref{Architecture Selection}).
3994 A target selection may also have variations for different operating
3995 systems or architectures.
3997 The command to list valid target values is @samp{objdump -i}
3998 (the first column of output contains the relevant information).
4000 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4001 @samp{a.out-sunos-big}.
4003 You can also specify a target using a configuration triplet. This is
4004 the same sort of name that is passed to @file{configure} to specify a
4005 target. When you use a configuration triplet as an argument, it must be
4006 fully canonicalized. You can see the canonical version of a triplet by
4007 running the shell script @file{config.sub} which is included with the
4010 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4011 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4013 @subheading @command{objdump} Target
4019 command line option: @option{-b} or @option{--target}
4022 environment variable @code{GNUTARGET}
4025 deduced from the input file
4028 @subheading @command{objcopy} and @command{strip} Input Target
4034 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4037 environment variable @code{GNUTARGET}
4040 deduced from the input file
4043 @subheading @command{objcopy} and @command{strip} Output Target
4049 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4052 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4055 environment variable @code{GNUTARGET}
4058 deduced from the input file
4061 @subheading @command{nm}, @command{size}, and @command{strings} Target
4067 command line option: @option{--target}
4070 environment variable @code{GNUTARGET}
4073 deduced from the input file
4076 @node Architecture Selection
4077 @section Architecture Selection
4079 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4080 to run. Its name may contain a colon, separating the name of the
4081 processor family from the name of the particular @sc{cpu}.
4083 The command to list valid architecture values is @samp{objdump -i} (the
4084 second column contains the relevant information).
4086 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4088 @subheading @command{objdump} Architecture
4094 command line option: @option{-m} or @option{--architecture}
4097 deduced from the input file
4100 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4106 deduced from the input file
4109 @node Reporting Bugs
4110 @chapter Reporting Bugs
4112 @cindex reporting bugs
4114 Your bug reports play an essential role in making the binary utilities
4117 Reporting a bug may help you by bringing a solution to your problem, or
4118 it may not. But in any case the principal function of a bug report is
4119 to help the entire community by making the next version of the binary
4120 utilities work better. Bug reports are your contribution to their
4123 In order for a bug report to serve its purpose, you must include the
4124 information that enables us to fix the bug.
4127 * Bug Criteria:: Have you found a bug?
4128 * Bug Reporting:: How to report bugs
4132 @section Have You Found a Bug?
4133 @cindex bug criteria
4135 If you are not sure whether you have found a bug, here are some guidelines:
4138 @cindex fatal signal
4141 If a binary utility gets a fatal signal, for any input whatever, that is
4142 a bug. Reliable utilities never crash.
4144 @cindex error on valid input
4146 If a binary utility produces an error message for valid input, that is a
4150 If you are an experienced user of binary utilities, your suggestions for
4151 improvement are welcome in any case.
4155 @section How to Report Bugs
4157 @cindex bugs, reporting
4159 A number of companies and individuals offer support for @sc{gnu}
4160 products. If you obtained the binary utilities from a support
4161 organization, we recommend you contact that organization first.
4163 You can find contact information for many support companies and
4164 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4168 In any event, we also recommend that you send bug reports for the binary
4169 utilities to @value{BUGURL}.
4172 The fundamental principle of reporting bugs usefully is this:
4173 @strong{report all the facts}. If you are not sure whether to state a
4174 fact or leave it out, state it!
4176 Often people omit facts because they think they know what causes the
4177 problem and assume that some details do not matter. Thus, you might
4178 assume that the name of a file you use in an example does not matter.
4179 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4180 a stray memory reference which happens to fetch from the location where
4181 that pathname is stored in memory; perhaps, if the pathname were
4182 different, the contents of that location would fool the utility into
4183 doing the right thing despite the bug. Play it safe and give a
4184 specific, complete example. That is the easiest thing for you to do,
4185 and the most helpful.
4187 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4188 it is new to us. Therefore, always write your bug reports on the assumption
4189 that the bug has not been reported previously.
4191 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4192 bell?'' This cannot help us fix a bug, so it is basically useless. We
4193 respond by asking for enough details to enable us to investigate.
4194 You might as well expedite matters by sending them to begin with.
4196 To enable us to fix the bug, you should include all these things:
4200 The version of the utility. Each utility announces it if you start it
4201 with the @option{--version} argument.
4203 Without this, we will not know whether there is any point in looking for
4204 the bug in the current version of the binary utilities.
4207 Any patches you may have applied to the source, including any patches
4208 made to the @code{BFD} library.
4211 The type of machine you are using, and the operating system name and
4215 What compiler (and its version) was used to compile the utilities---e.g.
4219 The command arguments you gave the utility to observe the bug. To
4220 guarantee you will not omit something important, list them all. A copy
4221 of the Makefile (or the output from make) is sufficient.
4223 If we were to try to guess the arguments, we would probably guess wrong
4224 and then we might not encounter the bug.
4227 A complete input file, or set of input files, that will reproduce the
4228 bug. If the utility is reading an object file or files, then it is
4229 generally most helpful to send the actual object files.
4231 If the source files were produced exclusively using @sc{gnu} programs
4232 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4233 may be OK to send the source files rather than the object files. In
4234 this case, be sure to say exactly what version of @command{gcc}, or
4235 whatever, was used to produce the object files. Also say how
4236 @command{gcc}, or whatever, was configured.
4239 A description of what behavior you observe that you believe is
4240 incorrect. For example, ``It gets a fatal signal.''
4242 Of course, if the bug is that the utility gets a fatal signal, then we
4243 will certainly notice it. But if the bug is incorrect output, we might
4244 not notice unless it is glaringly wrong. You might as well not give us
4245 a chance to make a mistake.
4247 Even if the problem you experience is a fatal signal, you should still
4248 say so explicitly. Suppose something strange is going on, such as your
4249 copy of the utility is out of sync, or you have encountered a bug in
4250 the C library on your system. (This has happened!) Your copy might
4251 crash and ours would not. If you told us to expect a crash, then when
4252 ours fails to crash, we would know that the bug was not happening for
4253 us. If you had not told us to expect a crash, then we would not be able
4254 to draw any conclusion from our observations.
4257 If you wish to suggest changes to the source, send us context diffs, as
4258 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4259 option. Always send diffs from the old file to the new file. If you
4260 wish to discuss something in the @command{ld} source, refer to it by
4261 context, not by line number.
4263 The line numbers in our development sources will not match those in your
4264 sources. Your line numbers would convey no useful information to us.
4267 Here are some things that are not necessary:
4271 A description of the envelope of the bug.
4273 Often people who encounter a bug spend a lot of time investigating
4274 which changes to the input file will make the bug go away and which
4275 changes will not affect it.
4277 This is often time consuming and not very useful, because the way we
4278 will find the bug is by running a single example under the debugger
4279 with breakpoints, not by pure deduction from a series of examples.
4280 We recommend that you save your time for something else.
4282 Of course, if you can find a simpler example to report @emph{instead}
4283 of the original one, that is a convenience for us. Errors in the
4284 output will be easier to spot, running under the debugger will take
4285 less time, and so on.
4287 However, simplification is not vital; if you do not want to do this,
4288 report the bug anyway and send us the entire test case you used.
4291 A patch for the bug.
4293 A patch for the bug does help us if it is a good one. But do not omit
4294 the necessary information, such as the test case, on the assumption that
4295 a patch is all we need. We might see problems with your patch and decide
4296 to fix the problem another way, or we might not understand it at all.
4298 Sometimes with programs as complicated as the binary utilities it is
4299 very hard to construct an example that will make the program follow a
4300 certain path through the code. If you do not send us the example, we
4301 will not be able to construct one, so we will not be able to verify that
4304 And if we cannot understand what bug you are trying to fix, or why your
4305 patch should be an improvement, we will not install it. A test case will
4306 help us to understand.
4309 A guess about what the bug is or what it depends on.
4311 Such guesses are usually wrong. Even we cannot guess right about such
4312 things without first using the debugger to find the facts.
4315 @node GNU Free Documentation License
4316 @appendix GNU Free Documentation License
4320 @node Binutils Index
4321 @unnumbered Binutils Index