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 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.2
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. A copy of the license is included in the
137 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 compatibility, @command{ar}
215 @cindex @command{ar} compatibility
216 @sc{gnu} @command{ar} is designed to be compatible with two different
217 facilities. You can control its activity using command-line options,
218 like the different varieties of @command{ar} on Unix systems; or, if you
219 specify the single command-line option @option{-M}, you can control it
220 with a script supplied via standard input, like the MRI ``librarian''
226 * ar cmdline:: Controlling @command{ar} on the command line
227 * ar scripts:: Controlling @command{ar} with a script
232 @section Controlling @command{ar} on the Command Line
235 @c man begin SYNOPSIS ar
236 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
240 @cindex Unix compatibility, @command{ar}
241 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
242 arguments to execute: one keyletter specifying the @emph{operation}
243 (optionally accompanied by other keyletters specifying
244 @emph{modifiers}), and the archive name to act on.
246 Most operations can also accept further @var{member} arguments,
247 specifying particular files to operate on.
249 @c man begin OPTIONS ar
251 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
252 flags @var{mod} in any order, within the first command-line argument.
254 If you wish, you may begin the first command-line argument with a
257 @cindex operations on archive
258 The @var{p} keyletter specifies what operation to execute; it may be
259 any of the following, but you must specify only one of them:
263 @cindex deleting from archive
264 @emph{Delete} modules from the archive. Specify the names of modules to
265 be deleted as @var{member}@dots{}; the archive is untouched if you
266 specify no files to delete.
268 If you specify the @samp{v} modifier, @command{ar} lists each module
272 @cindex moving in archive
273 Use this operation to @emph{move} members in an archive.
275 The ordering of members in an archive can make a difference in how
276 programs are linked using the library, if a symbol is defined in more
279 If no modifiers are used with @code{m}, any members you name in the
280 @var{member} arguments are moved to the @emph{end} of the archive;
281 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
282 specified place instead.
285 @cindex printing from archive
286 @emph{Print} the specified members of the archive, to the standard
287 output file. If the @samp{v} modifier is specified, show the member
288 name before copying its contents to standard output.
290 If you specify no @var{member} arguments, all the files in the archive are
294 @cindex quick append to archive
295 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
296 @var{archive}, without checking for replacement.
298 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
299 operation; new members are always placed at the end of the archive.
301 The modifier @samp{v} makes @command{ar} list each file as it is appended.
303 Since the point of this operation is speed, the archive's symbol table
304 index is not updated, even if it already existed; you can use @samp{ar s} or
305 @command{ranlib} explicitly to update the symbol table index.
307 However, too many different systems assume quick append rebuilds the
308 index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
311 @cindex replacement in archive
312 Insert the files @var{member}@dots{} into @var{archive} (with
313 @emph{replacement}). This operation differs from @samp{q} in that any
314 previously existing members are deleted if their names match those being
317 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
318 displays an error message, and leaves undisturbed any existing members
319 of the archive matching that name.
321 By default, new members are added at the end of the file; but you may
322 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
323 placement relative to some existing member.
325 The modifier @samp{v} used with this operation elicits a line of
326 output for each file inserted, along with one of the letters @samp{a} or
327 @samp{r} to indicate whether the file was appended (no old member
328 deleted) or replaced.
331 @cindex contents of archive
332 Display a @emph{table} listing the contents of @var{archive}, or those
333 of the files listed in @var{member}@dots{} that are present in the
334 archive. Normally only the member name is shown; if you also want to
335 see the modes (permissions), timestamp, owner, group, and size, you can
336 request that by also specifying the @samp{v} modifier.
338 If you do not specify a @var{member}, all files in the archive
341 @cindex repeated names in archive
342 @cindex name duplication in archive
343 If there is more than one file with the same name (say, @samp{fie}) in
344 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
345 first instance; to see them all, you must ask for a complete
346 listing---in our example, @samp{ar t b.a}.
347 @c WRS only; per Gumby, this is implementation-dependent, and in a more
348 @c recent case in fact works the other way.
351 @cindex extract from archive
352 @emph{Extract} members (named @var{member}) from the archive. You can
353 use the @samp{v} modifier with this operation, to request that
354 @command{ar} list each name as it extracts it.
356 If you do not specify a @var{member}, all files in the archive
361 A number of modifiers (@var{mod}) may immediately follow the @var{p}
362 keyletter, to specify variations on an operation's behavior:
366 @cindex relative placement in archive
367 Add new files @emph{after} an existing member of the
368 archive. If you use the modifier @samp{a}, the name of an existing archive
369 member must be present as the @var{relpos} argument, before the
370 @var{archive} specification.
373 Add new files @emph{before} an existing member of the
374 archive. If you use the modifier @samp{b}, the name of an existing archive
375 member must be present as the @var{relpos} argument, before the
376 @var{archive} specification. (same as @samp{i}).
379 @cindex creating archives
380 @emph{Create} the archive. The specified @var{archive} is always
381 created if it did not exist, when you request an update. But a warning is
382 issued unless you specify in advance that you expect to create it, by
386 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
387 names of any length. This will cause it to create archives which are
388 not compatible with the native @command{ar} program on some systems. If
389 this is a concern, the @samp{f} modifier may be used to truncate file
390 names when putting them in the archive.
393 Insert new files @emph{before} an existing member of the
394 archive. If you use the modifier @samp{i}, the name of an existing archive
395 member must be present as the @var{relpos} argument, before the
396 @var{archive} specification. (same as @samp{b}).
399 This modifier is accepted but not used.
400 @c whaffor ar l modifier??? presumably compat; with
401 @c what???---doc@@cygnus.com, 25jan91
404 Uses the @var{count} parameter. This is used if there are multiple
405 entries in the archive with the same name. Extract or delete instance
406 @var{count} of the given name from the archive.
409 @cindex dates in archive
410 Preserve the @emph{original} dates of members when extracting them. If
411 you do not specify this modifier, files extracted from the archive
412 are stamped with the time of extraction.
415 Use the full path name when matching names in the archive. @sc{gnu}
416 @command{ar} can not create an archive with a full path name (such archives
417 are not POSIX complaint), but other archive creators can. This option
418 will cause @sc{gnu} @command{ar} to match file names using a complete path
419 name, which can be convenient when extracting a single file from an
420 archive created by another tool.
423 @cindex writing archive index
424 Write an object-file index into the archive, or update an existing one,
425 even if no other change is made to the archive. You may use this modifier
426 flag either with any operation, or alone. Running @samp{ar s} on an
427 archive is equivalent to running @samp{ranlib} on it.
430 @cindex not writing archive index
431 Do not generate an archive symbol table. This can speed up building a
432 large library in several steps. The resulting archive can not be used
433 with the linker. In order to build a symbol table, you must omit the
434 @samp{S} modifier on the last execution of @samp{ar}, or you must run
435 @samp{ranlib} on the archive.
438 @cindex updating an archive
439 Normally, @samp{ar r}@dots{} inserts all files
440 listed into the archive. If you would like to insert @emph{only} those
441 of the files you list that are newer than existing members of the same
442 names, use this modifier. The @samp{u} modifier is allowed only for the
443 operation @samp{r} (replace). In particular, the combination @samp{qu} is
444 not allowed, since checking the timestamps would lose any speed
445 advantage from the operation @samp{q}.
448 This modifier requests the @emph{verbose} version of an operation. Many
449 operations display additional information, such as filenames processed,
450 when the modifier @samp{v} is appended.
453 This modifier shows the version number of @command{ar}.
456 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
457 compatibility with AIX. The behaviour produced by this option is the
458 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
459 @samp{-X} options; in particular, it does not support @option{-X32}
460 which is the default for AIX @command{ar}.
465 @c man begin SEEALSO ar
466 nm(1), ranlib(1), and the Info entries for @file{binutils}.
471 @section Controlling @command{ar} with a Script
474 ar -M [ <@var{script} ]
477 @cindex MRI compatibility, @command{ar}
478 @cindex scripts, @command{ar}
479 If you use the single command-line option @samp{-M} with @command{ar}, you
480 can control its operation with a rudimentary command language. This
481 form of @command{ar} operates interactively if standard input is coming
482 directly from a terminal. During interactive use, @command{ar} prompts for
483 input (the prompt is @samp{AR >}), and continues executing even after
484 errors. If you redirect standard input to a script file, no prompts are
485 issued, and @command{ar} abandons execution (with a nonzero exit code)
488 The @command{ar} command language is @emph{not} designed to be equivalent
489 to the command-line options; in fact, it provides somewhat less control
490 over archives. The only purpose of the command language is to ease the
491 transition to @sc{gnu} @command{ar} for developers who already have scripts
492 written for the MRI ``librarian'' program.
494 The syntax for the @command{ar} command language is straightforward:
497 commands are recognized in upper or lower case; for example, @code{LIST}
498 is the same as @code{list}. In the following descriptions, commands are
499 shown in upper case for clarity.
502 a single command may appear on each line; it is the first word on the
506 empty lines are allowed, and have no effect.
509 comments are allowed; text after either of the characters @samp{*}
510 or @samp{;} is ignored.
513 Whenever you use a list of names as part of the argument to an @command{ar}
514 command, you can separate the individual names with either commas or
515 blanks. Commas are shown in the explanations below, for clarity.
518 @samp{+} is used as a line continuation character; if @samp{+} appears
519 at the end of a line, the text on the following line is considered part
520 of the current command.
523 Here are the commands you can use in @command{ar} scripts, or when using
524 @command{ar} interactively. Three of them have special significance:
526 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
527 a temporary file required for most of the other commands.
529 @code{SAVE} commits the changes so far specified by the script. Prior
530 to @code{SAVE}, commands affect only the temporary copy of the current
534 @item ADDLIB @var{archive}
535 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
536 Add all the contents of @var{archive} (or, if specified, each named
537 @var{module} from @var{archive}) to the current archive.
539 Requires prior use of @code{OPEN} or @code{CREATE}.
541 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
542 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
543 @c else like "ar q..."
544 Add each named @var{member} as a module in the current archive.
546 Requires prior use of @code{OPEN} or @code{CREATE}.
549 Discard the contents of the current archive, canceling the effect of
550 any operations since the last @code{SAVE}. May be executed (with no
551 effect) even if no current archive is specified.
553 @item CREATE @var{archive}
554 Creates an archive, and makes it the current archive (required for many
555 other commands). The new archive is created with a temporary name; it
556 is not actually saved as @var{archive} until you use @code{SAVE}.
557 You can overwrite existing archives; similarly, the contents of any
558 existing file named @var{archive} will not be destroyed until @code{SAVE}.
560 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
561 Delete each listed @var{module} from the current archive; equivalent to
562 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
564 Requires prior use of @code{OPEN} or @code{CREATE}.
566 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
567 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
568 List each named @var{module} present in @var{archive}. The separate
569 command @code{VERBOSE} specifies the form of the output: when verbose
570 output is off, output is like that of @samp{ar -t @var{archive}
571 @var{module}@dots{}}. When verbose output is on, the listing is like
572 @samp{ar -tv @var{archive} @var{module}@dots{}}.
574 Output normally goes to the standard output stream; however, if you
575 specify @var{outputfile} as a final argument, @command{ar} directs the
579 Exit from @command{ar}, with a @code{0} exit code to indicate successful
580 completion. This command does not save the output file; if you have
581 changed the current archive since the last @code{SAVE} command, those
584 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
585 Extract each named @var{module} from the current archive, writing them
586 into the current directory as separate files. Equivalent to @samp{ar -x
587 @var{archive} @var{module}@dots{}}.
589 Requires prior use of @code{OPEN} or @code{CREATE}.
592 @c FIXME Tokens but no commands???
599 Display full contents of the current archive, in ``verbose'' style
600 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
601 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
602 enhancement, rather than present for MRI compatibility.)
604 Requires prior use of @code{OPEN} or @code{CREATE}.
606 @item OPEN @var{archive}
607 Opens an existing archive for use as the current archive (required for
608 many other commands). Any changes as the result of subsequent commands
609 will not actually affect @var{archive} until you next use @code{SAVE}.
611 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
612 In the current archive, replace each existing @var{module} (named in
613 the @code{REPLACE} arguments) from files in the current working directory.
614 To execute this command without errors, both the file, and the module in
615 the current archive, must exist.
617 Requires prior use of @code{OPEN} or @code{CREATE}.
620 Toggle an internal flag governing the output from @code{DIRECTORY}.
621 When the flag is on, @code{DIRECTORY} output matches output from
622 @samp{ar -tv }@dots{}.
625 Commit your changes to the current archive, and actually save it as a
626 file with the name specified in the last @code{CREATE} or @code{OPEN}
629 Requires prior use of @code{OPEN} or @code{CREATE}.
638 The @sc{gnu} linker @command{ld} is now described in a separate manual.
639 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
647 @c man title nm list symbols from object files
650 @c man begin SYNOPSIS nm
651 nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]
652 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
653 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
654 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
655 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
656 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
657 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
658 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
659 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
660 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
664 @c man begin DESCRIPTION nm
665 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
666 If no object files are listed as arguments, @command{nm} assumes the file
669 For each symbol, @command{nm} shows:
673 The symbol value, in the radix selected by options (see below), or
674 hexadecimal by default.
677 The symbol type. At least the following types are used; others are, as
678 well, depending on the object file format. If lowercase, the symbol is
679 local; if uppercase, the symbol is global (external).
681 @c Some more detail on exactly what these symbol types are used for
685 The symbol's value is absolute, and will not be changed by further
690 The symbol is in the uninitialized data section (known as BSS).
693 The symbol is common. Common symbols are uninitialized data. When
694 linking, multiple common symbols may appear with the same name. If the
695 symbol is defined anywhere, the common symbols are treated as undefined
698 For more details on common symbols, see the discussion of
699 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
704 The symbol is in the initialized data section.
708 The symbol is in an initialized data section for small objects. Some
709 object file formats permit more efficient access to small data objects,
710 such as a global int variable as opposed to a large global array.
713 The symbol is an indirect reference to another symbol. This is a @sc{gnu}
714 extension to the a.out object file format which is rarely used.
717 The symbol is in a section specific to the implementation of DLLs.
720 The symbol is a debugging symbol.
723 The symbols is in a stack unwind section.
727 The symbol is in a read only data section.
731 The symbol is in an uninitialized data section for small objects.
735 The symbol is in the text (code) section.
738 The symbol is undefined.
742 The symbol is a weak object. When a weak defined symbol is linked with
743 a normal defined symbol, the normal defined symbol is used with no error.
744 When a weak undefined symbol is linked and the symbol is not defined,
745 the value of the weak symbol becomes zero with no error. On some
746 systems, uppercase indicates that a default value has been specified.
750 The symbol is a weak symbol that has not been specifically tagged as a
751 weak object symbol. When a weak defined symbol is linked with a normal
752 defined symbol, the normal defined symbol is used with no error.
753 When a weak undefined symbol is linked and the symbol is not defined,
754 the value of the symbol is determined in a system-specific manner without
755 error. On some systems, uppercase indicates that a default value has been
759 The symbol is a stabs symbol in an a.out object file. In this case, the
760 next values printed are the stabs other field, the stabs desc field, and
761 the stab type. Stabs symbols are used to hold debugging information.
763 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
764 ``stabs'' debug format}.
768 The symbol type is unknown, or object file format specific.
777 @c man begin OPTIONS nm
778 The long and short forms of options, shown here as alternatives, are
784 @itemx --print-file-name
785 @cindex input file name
787 @cindex source file name
788 Precede each symbol by the name of the input file (or archive member)
789 in which it was found, rather than identifying the input file once only,
790 before all of its symbols.
794 @cindex debugging symbols
795 Display all symbols, even debugger-only symbols; normally these are not
799 @cindex @command{nm} format
800 @cindex @command{nm} compatibility
801 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
804 @itemx --demangle[=@var{style}]
805 @cindex demangling in nm
806 Decode (@dfn{demangle}) low-level symbol names into user-level names.
807 Besides removing any initial underscore prepended by the system, this
808 makes C++ function names readable. Different compilers have different
809 mangling styles. The optional demangling style argument can be used to
810 choose an appropriate demangling style for your compiler. @xref{c++filt},
811 for more information on demangling.
814 Do not demangle low-level symbol names. This is the default.
818 @cindex dynamic symbols
819 Display the dynamic symbols rather than the normal symbols. This is
820 only meaningful for dynamic objects, such as certain types of shared
823 @item -f @var{format}
824 @itemx --format=@var{format}
825 @cindex @command{nm} format
826 @cindex @command{nm} compatibility
827 Use the output format @var{format}, which can be @code{bsd},
828 @code{sysv}, or @code{posix}. The default is @code{bsd}.
829 Only the first character of @var{format} is significant; it can be
830 either upper or lower case.
834 @cindex external symbols
835 Display only external symbols.
838 @itemx --line-numbers
839 @cindex symbol line numbers
840 For each symbol, use debugging information to try to find a filename and
841 line number. For a defined symbol, look for the line number of the
842 address of the symbol. For an undefined symbol, look for the line
843 number of a relocation entry which refers to the symbol. If line number
844 information can be found, print it after the other symbol information.
848 @itemx --numeric-sort
849 Sort symbols numerically by their addresses, rather than alphabetically
854 @cindex sorting symbols
855 Do not bother to sort the symbols in any order; print them in the order
860 Use the POSIX.2 standard output format instead of the default format.
861 Equivalent to @samp{-f posix}.
865 Print size, not the value, of defined symbols for the @code{bsd} output format.
869 @cindex symbol index, listing
870 When listing symbols from archive members, include the index: a mapping
871 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
872 contain definitions for which names.
875 @itemx --reverse-sort
876 Reverse the order of the sort (whether numeric or alphabetic); let the
880 Sort symbols by size. The size is computed as the difference between
881 the value of the symbol and the value of the symbol with the next higher
882 value. If the @code{bsd} output format is used the size of the symbol
883 is printed, rather than the value, and @samp{-S} must be used in order
884 both size and value to be printed.
887 Display symbols which have a target-specific special meaning. These
888 symbols are usually used by the target for some special processing and
889 are not normally helpful when included included in the normal symbol
890 lists. For example for ARM targets this option would skip the mapping
891 symbols used to mark transitions between ARM code, THUMB code and
895 @itemx --radix=@var{radix}
896 Use @var{radix} as the radix for printing the symbol values. It must be
897 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
899 @item --target=@var{bfdname}
900 @cindex object code format
901 Specify an object code format other than your system's default format.
902 @xref{Target Selection}, for more information.
905 @itemx --undefined-only
906 @cindex external symbols
907 @cindex undefined symbols
908 Display only undefined symbols (those external to each object file).
911 @cindex external symbols
912 @cindex undefined symbols
913 Display only defined symbols for each object file.
917 Show the version number of @command{nm} and exit.
920 This option is ignored for compatibility with the AIX version of
921 @command{nm}. It takes one parameter which must be the string
922 @option{32_64}. The default mode of AIX @command{nm} corresponds
923 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
926 Show a summary of the options to @command{nm} and exit.
932 @c man begin SEEALSO nm
933 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
940 @c man title objcopy copy and translate object files
943 @c man begin SYNOPSIS objcopy
944 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
945 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
946 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
947 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
948 [@option{-S}|@option{--strip-all}]
949 [@option{-g}|@option{--strip-debug}]
950 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
951 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
952 [@option{--strip-unneeded-symbol=}@var{symbolname}]
953 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
954 [@option{--localize-hidden}]
955 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
956 [@option{--globalize-symbol=}@var{symbolname}]
957 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
958 [@option{-w}|@option{--wildcard}]
959 [@option{-x}|@option{--discard-all}]
960 [@option{-X}|@option{--discard-locals}]
961 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
962 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
963 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
964 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
965 [@option{-p}|@option{--preserve-dates}]
966 [@option{--debugging}]
967 [@option{--gap-fill=}@var{val}]
968 [@option{--pad-to=}@var{address}]
969 [@option{--set-start=}@var{val}]
970 [@option{--adjust-start=}@var{incr}]
971 [@option{--change-addresses=}@var{incr}]
972 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
973 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
974 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
975 [@option{--change-warnings}] [@option{--no-change-warnings}]
976 [@option{--set-section-flags} @var{section}=@var{flags}]
977 [@option{--add-section} @var{sectionname}=@var{filename}]
978 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
979 [@option{--change-leading-char}] [@option{--remove-leading-char}]
980 [@option{--reverse-bytes=}@var{num}]
981 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
982 [@option{--redefine-sym} @var{old}=@var{new}]
983 [@option{--redefine-syms=}@var{filename}]
985 [@option{--keep-symbols=}@var{filename}]
986 [@option{--strip-symbols=}@var{filename}]
987 [@option{--strip-unneeded-symbols=}@var{filename}]
988 [@option{--keep-global-symbols=}@var{filename}]
989 [@option{--localize-symbols=}@var{filename}]
990 [@option{--globalize-symbols=}@var{filename}]
991 [@option{--weaken-symbols=}@var{filename}]
992 [@option{--alt-machine-code=}@var{index}]
993 [@option{--prefix-symbols=}@var{string}]
994 [@option{--prefix-sections=}@var{string}]
995 [@option{--prefix-alloc-sections=}@var{string}]
996 [@option{--add-gnu-debuglink=}@var{path-to-file}]
997 [@option{--keep-file-symbols}]
998 [@option{--only-keep-debug}]
999 [@option{--extract-symbol}]
1000 [@option{--writable-text}]
1001 [@option{--readonly-text}]
1004 [@option{-v}|@option{--verbose}]
1005 [@option{-V}|@option{--version}]
1006 [@option{--help}] [@option{--info}]
1007 @var{infile} [@var{outfile}]
1011 @c man begin DESCRIPTION objcopy
1012 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1013 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1014 read and write the object files. It can write the destination object
1015 file in a format different from that of the source object file. The
1016 exact behavior of @command{objcopy} is controlled by command-line options.
1017 Note that @command{objcopy} should be able to copy a fully linked file
1018 between any two formats. However, copying a relocatable object file
1019 between any two formats may not work as expected.
1021 @command{objcopy} creates temporary files to do its translations and
1022 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1023 translation work; it has access to all the formats described in @sc{bfd}
1024 and thus is able to recognize most formats without being told
1025 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1027 @command{objcopy} can be used to generate S-records by using an output
1028 target of @samp{srec} (e.g., use @samp{-O srec}).
1030 @command{objcopy} can be used to generate a raw binary file by using an
1031 output target of @samp{binary} (e.g., use @option{-O binary}). When
1032 @command{objcopy} generates a raw binary file, it will essentially produce
1033 a memory dump of the contents of the input object file. All symbols and
1034 relocation information will be discarded. The memory dump will start at
1035 the load address of the lowest section copied into the output file.
1037 When generating an S-record or a raw binary file, it may be helpful to
1038 use @option{-S} to remove sections containing debugging information. In
1039 some cases @option{-R} will be useful to remove sections which contain
1040 information that is not needed by the binary file.
1042 Note---@command{objcopy} is not able to change the endianness of its input
1043 files. If the input format has an endianness (some formats do not),
1044 @command{objcopy} can only copy the inputs into file formats that have the
1045 same endianness or which have no endianness (e.g., @samp{srec}).
1046 (However, see the @option{--reverse-bytes} option.)
1050 @c man begin OPTIONS objcopy
1054 @itemx @var{outfile}
1055 The input and output files, respectively.
1056 If you do not specify @var{outfile}, @command{objcopy} creates a
1057 temporary file and destructively renames the result with
1058 the name of @var{infile}.
1060 @item -I @var{bfdname}
1061 @itemx --input-target=@var{bfdname}
1062 Consider the source file's object format to be @var{bfdname}, rather than
1063 attempting to deduce it. @xref{Target Selection}, for more information.
1065 @item -O @var{bfdname}
1066 @itemx --output-target=@var{bfdname}
1067 Write the output file using the object format @var{bfdname}.
1068 @xref{Target Selection}, for more information.
1070 @item -F @var{bfdname}
1071 @itemx --target=@var{bfdname}
1072 Use @var{bfdname} as the object format for both the input and the output
1073 file; i.e., simply transfer data from source to destination with no
1074 translation. @xref{Target Selection}, for more information.
1076 @item -B @var{bfdarch}
1077 @itemx --binary-architecture=@var{bfdarch}
1078 Useful when transforming a raw binary input file into an object file.
1079 In this case the output architecture can be set to @var{bfdarch}. This
1080 option will be ignored if the input file has a known @var{bfdarch}. You
1081 can access this binary data inside a program by referencing the special
1082 symbols that are created by the conversion process. These symbols are
1083 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1084 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1085 an object file and then access it in your code using these symbols.
1087 @item -j @var{sectionname}
1088 @itemx --only-section=@var{sectionname}
1089 Copy only the named section from the input file to the output file.
1090 This option may be given more than once. Note that using this option
1091 inappropriately may make the output file unusable.
1093 @item -R @var{sectionname}
1094 @itemx --remove-section=@var{sectionname}
1095 Remove any section named @var{sectionname} from the output file. This
1096 option may be given more than once. Note that using this option
1097 inappropriately may make the output file unusable.
1101 Do not copy relocation and symbol information from the source file.
1104 @itemx --strip-debug
1105 Do not copy debugging symbols or sections from the source file.
1107 @item --strip-unneeded
1108 Strip all symbols that are not needed for relocation processing.
1110 @item -K @var{symbolname}
1111 @itemx --keep-symbol=@var{symbolname}
1112 When stripping symbols, keep symbol @var{symbolname} even if it would
1113 normally be stripped. This option may be given more than once.
1115 @item -N @var{symbolname}
1116 @itemx --strip-symbol=@var{symbolname}
1117 Do not copy symbol @var{symbolname} from the source file. This option
1118 may be given more than once.
1120 @item --strip-unneeded-symbol=@var{symbolname}
1121 Do not copy symbol @var{symbolname} from the source file unless it is needed
1122 by a relocation. This option may be given more than once.
1124 @item -G @var{symbolname}
1125 @itemx --keep-global-symbol=@var{symbolname}
1126 Keep only symbol @var{symbolname} global. Make all other symbols local
1127 to the file, so that they are not visible externally. This option may
1128 be given more than once.
1130 @item --localize-hidden
1131 In an ELF object, mark all symbols that have hidden or internal visibility
1132 as local. This option applies on top of symbol-specific localization options
1133 such as @option{-L}.
1135 @item -L @var{symbolname}
1136 @itemx --localize-symbol=@var{symbolname}
1137 Make symbol @var{symbolname} local to the file, so that it is not
1138 visible externally. This option may be given more than once.
1140 @item -W @var{symbolname}
1141 @itemx --weaken-symbol=@var{symbolname}
1142 Make symbol @var{symbolname} weak. This option may be given more than once.
1144 @item --globalize-symbol=@var{symbolname}
1145 Give symbol @var{symbolname} global scoping so that it is visible
1146 outside of the file in which it is defined. This option may be given
1151 Permit regular expressions in @var{symbolname}s used in other command
1152 line options. The question mark (?), asterisk (*), backslash (\) and
1153 square brackets ([]) operators can be used anywhere in the symbol
1154 name. If the first character of the symbol name is the exclamation
1155 point (!) then the sense of the switch is reversed for that symbol.
1162 would cause objcopy to weaken all symbols that start with ``fo''
1163 except for the symbol ``foo''.
1166 @itemx --discard-all
1167 Do not copy non-global symbols from the source file.
1168 @c FIXME any reason to prefer "non-global" to "local" here?
1171 @itemx --discard-locals
1172 Do not copy compiler-generated local symbols.
1173 (These usually start with @samp{L} or @samp{.}.)
1176 @itemx --byte=@var{byte}
1177 Keep only every @var{byte}th byte of the input file (header data is not
1178 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1179 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1180 option, or the default of 4. This option is useful for creating files
1181 to program @sc{rom}. It is typically used with an @code{srec} output
1184 @item -i @var{interleave}
1185 @itemx --interleave=@var{interleave}
1186 Only copy one out of every @var{interleave} bytes. Select which byte to
1187 copy with the @option{-b} or @option{--byte} option. The default is 4.
1188 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1192 @itemx --preserve-dates
1193 Set the access and modification dates of the output file to be the same
1194 as those of the input file.
1197 Convert debugging information, if possible. This is not the default
1198 because only certain debugging formats are supported, and the
1199 conversion process can be time consuming.
1201 @item --gap-fill @var{val}
1202 Fill gaps between sections with @var{val}. This operation applies to
1203 the @emph{load address} (LMA) of the sections. It is done by increasing
1204 the size of the section with the lower address, and filling in the extra
1205 space created with @var{val}.
1207 @item --pad-to @var{address}
1208 Pad the output file up to the load address @var{address}. This is
1209 done by increasing the size of the last section. The extra space is
1210 filled in with the value specified by @option{--gap-fill} (default zero).
1212 @item --set-start @var{val}
1213 Set the start address of the new file to @var{val}. Not all object file
1214 formats support setting the start address.
1216 @item --change-start @var{incr}
1217 @itemx --adjust-start @var{incr}
1218 @cindex changing start address
1219 Change the start address by adding @var{incr}. Not all object file
1220 formats support setting the start address.
1222 @item --change-addresses @var{incr}
1223 @itemx --adjust-vma @var{incr}
1224 @cindex changing object addresses
1225 Change the VMA and LMA addresses of all sections, as well as the start
1226 address, by adding @var{incr}. Some object file formats do not permit
1227 section addresses to be changed arbitrarily. Note that this does not
1228 relocate the sections; if the program expects sections to be loaded at a
1229 certain address, and this option is used to change the sections such
1230 that they are loaded at a different address, the program may fail.
1232 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1233 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1234 @cindex changing section address
1235 Set or change both the VMA address and the LMA address of the named
1236 @var{section}. If @samp{=} is used, the section address is set to
1237 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1238 section address. See the comments under @option{--change-addresses},
1239 above. If @var{section} does not exist in the input file, a warning will
1240 be issued, unless @option{--no-change-warnings} is used.
1242 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1243 @cindex changing section LMA
1244 Set or change the LMA address of the named @var{section}. The LMA
1245 address is the address where the section will be loaded into memory at
1246 program load time. Normally this is the same as the VMA address, which
1247 is the address of the section at program run time, but on some systems,
1248 especially those where a program is held in ROM, the two can be
1249 different. If @samp{=} is used, the section address is set to
1250 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1251 section address. See the comments under @option{--change-addresses},
1252 above. If @var{section} does not exist in the input file, a warning
1253 will be issued, unless @option{--no-change-warnings} is used.
1255 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1256 @cindex changing section VMA
1257 Set or change the VMA address of the named @var{section}. The VMA
1258 address is the address where the section will be located once the
1259 program has started executing. Normally this is the same as the LMA
1260 address, which is the address where the section will be loaded into
1261 memory, but on some systems, especially those where a program is held in
1262 ROM, the two can be different. If @samp{=} is used, the section address
1263 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1264 from the section address. See the comments under
1265 @option{--change-addresses}, above. If @var{section} does not exist in
1266 the input file, a warning will be issued, unless
1267 @option{--no-change-warnings} is used.
1269 @item --change-warnings
1270 @itemx --adjust-warnings
1271 If @option{--change-section-address} or @option{--change-section-lma} or
1272 @option{--change-section-vma} is used, and the named section does not
1273 exist, issue a warning. This is the default.
1275 @item --no-change-warnings
1276 @itemx --no-adjust-warnings
1277 Do not issue a warning if @option{--change-section-address} or
1278 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1279 if the named section does not exist.
1281 @item --set-section-flags @var{section}=@var{flags}
1282 Set the flags for the named section. The @var{flags} argument is a
1283 comma separated string of flag names. The recognized names are
1284 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1285 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1286 @samp{debug}. You can set the @samp{contents} flag for a section which
1287 does not have contents, but it is not meaningful to clear the
1288 @samp{contents} flag of a section which does have contents--just remove
1289 the section instead. Not all flags are meaningful for all object file
1292 @item --add-section @var{sectionname}=@var{filename}
1293 Add a new section named @var{sectionname} while copying the file. The
1294 contents of the new section are taken from the file @var{filename}. The
1295 size of the section will be the size of the file. This option only
1296 works on file formats which can support sections with arbitrary names.
1298 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1299 Rename a section from @var{oldname} to @var{newname}, optionally
1300 changing the section's flags to @var{flags} in the process. This has
1301 the advantage over usng a linker script to perform the rename in that
1302 the output stays as an object file and does not become a linked
1305 This option is particularly helpful when the input format is binary,
1306 since this will always create a section called .data. If for example,
1307 you wanted instead to create a section called .rodata containing binary
1308 data you could use the following command line to achieve it:
1311 objcopy -I binary -O <output_format> -B <architecture> \
1312 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1313 <input_binary_file> <output_object_file>
1316 @item --change-leading-char
1317 Some object file formats use special characters at the start of
1318 symbols. The most common such character is underscore, which compilers
1319 often add before every symbol. This option tells @command{objcopy} to
1320 change the leading character of every symbol when it converts between
1321 object file formats. If the object file formats use the same leading
1322 character, this option has no effect. Otherwise, it will add a
1323 character, or remove a character, or change a character, as
1326 @item --remove-leading-char
1327 If the first character of a global symbol is a special symbol leading
1328 character used by the object file format, remove the character. The
1329 most common symbol leading character is underscore. This option will
1330 remove a leading underscore from all global symbols. This can be useful
1331 if you want to link together objects of different file formats with
1332 different conventions for symbol names. This is different from
1333 @option{--change-leading-char} because it always changes the symbol name
1334 when appropriate, regardless of the object file format of the output
1337 @item --reverse-bytes=@var{num}
1338 Reverse the bytes in a section with output contents. A section length must
1339 be evenly divisible by the value given in order for the swap to be able to
1340 take place. Reversing takes place before the interleaving is performed.
1342 This option is used typically in generating ROM images for problematic
1343 target systems. For example, on some target boards, the 32-bit words
1344 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1345 regardless of the CPU byte order. Depending on the programming model, the
1346 endianness of the ROM may need to be modified.
1348 Consider a simple file with a section containing the following eight
1349 bytes: @code{12345678}.
1351 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1352 output file would be ordered @code{21436587}.
1354 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1355 output file would be ordered @code{43218765}.
1357 By using @samp{--reverse-bytes=2} for the above example, followed by
1358 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1359 output file would be ordered @code{34127856}.
1361 @item --srec-len=@var{ival}
1362 Meaningful only for srec output. Set the maximum length of the Srecords
1363 being produced to @var{ival}. This length covers both address, data and
1366 @item --srec-forceS3
1367 Meaningful only for srec output. Avoid generation of S1/S2 records,
1368 creating S3-only record format.
1370 @item --redefine-sym @var{old}=@var{new}
1371 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1372 when one is trying link two things together for which you have no
1373 source, and there are name collisions.
1375 @item --redefine-syms=@var{filename}
1376 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1377 listed in the file @var{filename}. @var{filename} is simply a flat file,
1378 with one symbol pair per line. Line comments may be introduced by the hash
1379 character. This option may be given more than once.
1382 Change all global symbols in the file to be weak. This can be useful
1383 when building an object which will be linked against other objects using
1384 the @option{-R} option to the linker. This option is only effective when
1385 using an object file format which supports weak symbols.
1387 @item --keep-symbols=@var{filename}
1388 Apply @option{--keep-symbol} option to each symbol listed in the file
1389 @var{filename}. @var{filename} is simply a flat file, with one symbol
1390 name per line. Line comments may be introduced by the hash character.
1391 This option may be given more than once.
1393 @item --strip-symbols=@var{filename}
1394 Apply @option{--strip-symbol} option to each symbol listed in the file
1395 @var{filename}. @var{filename} is simply a flat file, with one symbol
1396 name per line. Line comments may be introduced by the hash character.
1397 This option may be given more than once.
1399 @item --strip-unneeded-symbols=@var{filename}
1400 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1401 the file @var{filename}. @var{filename} is simply a flat file, with one
1402 symbol name per line. Line comments may be introduced by the hash
1403 character. This option may be given more than once.
1405 @item --keep-global-symbols=@var{filename}
1406 Apply @option{--keep-global-symbol} option to each symbol listed in the
1407 file @var{filename}. @var{filename} is simply a flat file, with one
1408 symbol name per line. Line comments may be introduced by the hash
1409 character. This option may be given more than once.
1411 @item --localize-symbols=@var{filename}
1412 Apply @option{--localize-symbol} option to each symbol listed in the file
1413 @var{filename}. @var{filename} is simply a flat file, with one symbol
1414 name per line. Line comments may be introduced by the hash character.
1415 This option may be given more than once.
1417 @item --globalize-symbols=@var{filename}
1418 Apply @option{--globalize-symbol} option to each symbol listed in the file
1419 @var{filename}. @var{filename} is simply a flat file, with one symbol
1420 name per line. Line comments may be introduced by the hash character.
1421 This option may be given more than once.
1423 @item --weaken-symbols=@var{filename}
1424 Apply @option{--weaken-symbol} option to each symbol listed in the file
1425 @var{filename}. @var{filename} is simply a flat file, with one symbol
1426 name per line. Line comments may be introduced by the hash character.
1427 This option may be given more than once.
1429 @item --alt-machine-code=@var{index}
1430 If the output architecture has alternate machine codes, use the
1431 @var{index}th code instead of the default one. This is useful in case
1432 a machine is assigned an official code and the tool-chain adopts the
1433 new code, but other applications still depend on the original code
1434 being used. For ELF based architectures if the @var{index}
1435 alternative does not exist then the value is treated as an absolute
1436 number to be stored in the e_machine field of the ELF header.
1438 @item --writable-text
1439 Mark the output text as writable. This option isn't meaningful for all
1440 object file formats.
1442 @item --readonly-text
1443 Make the output text write protected. This option isn't meaningful for all
1444 object file formats.
1447 Mark the output file as demand paged. This option isn't meaningful for all
1448 object file formats.
1451 Mark the output file as impure. This option isn't meaningful for all
1452 object file formats.
1454 @item --prefix-symbols=@var{string}
1455 Prefix all symbols in the output file with @var{string}.
1457 @item --prefix-sections=@var{string}
1458 Prefix all section names in the output file with @var{string}.
1460 @item --prefix-alloc-sections=@var{string}
1461 Prefix all the names of all allocated sections in the output file with
1464 @item --add-gnu-debuglink=@var{path-to-file}
1465 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1466 and adds it to the output file.
1468 @item --keep-file-symbols
1469 When stripping a file, perhaps with @option{--strip-debug} or
1470 @option{--strip-unneeded}, retain any symbols specifying source file names,
1471 which would otherwise get stripped.
1473 @item --only-keep-debug
1474 Strip a file, removing contents of any sections that would not be
1475 stripped by @option{--strip-debug} and leaving the debugging sections
1476 intact. In ELF files, this preserves all note sections in the output.
1478 The intention is that this option will be used in conjunction with
1479 @option{--add-gnu-debuglink} to create a two part executable. One a
1480 stripped binary which will occupy less space in RAM and in a
1481 distribution and the second a debugging information file which is only
1482 needed if debugging abilities are required. The suggested procedure
1483 to create these files is as follows:
1486 @item Link the executable as normal. Assuming that is is called
1488 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1489 create a file containing the debugging info.
1490 @item Run @code{objcopy --strip-debug foo} to create a
1491 stripped executable.
1492 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1493 to add a link to the debugging info into the stripped executable.
1496 Note---the choice of @code{.dbg} as an extension for the debug info
1497 file is arbitrary. Also the @code{--only-keep-debug} step is
1498 optional. You could instead do this:
1501 @item Link the executable as normal.
1502 @item Copy @code{foo} to @code{foo.full}
1503 @item Run @code{objcopy --strip-debug foo}
1504 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1507 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1508 full executable. It does not have to be a file created by the
1509 @option{--only-keep-debug} switch.
1511 Note---this switch is only intended for use on fully linked files. It
1512 does not make sense to use it on object files where the debugging
1513 information may be incomplete. Besides the gnu_debuglink feature
1514 currently only supports the presence of one filename containing
1515 debugging information, not multiple filenames on a one-per-object-file
1518 @item --extract-symbol
1519 Keep the file's section flags and symbols but remove all section data.
1520 Specifically, the option:
1523 @item sets the virtual and load addresses of every section to zero;
1524 @item removes the contents of all sections;
1525 @item sets the size of every section to zero; and
1526 @item sets the file's start address to zero.
1529 This option is used to build a @file{.sym} file for a VxWorks kernel.
1530 It can also be a useful way of reducing the size of a @option{--just-symbols}
1535 Show the version number of @command{objcopy}.
1539 Verbose output: list all object files modified. In the case of
1540 archives, @samp{objcopy -V} lists all members of the archive.
1543 Show a summary of the options to @command{objcopy}.
1546 Display a list showing all architectures and object formats available.
1552 @c man begin SEEALSO objcopy
1553 ld(1), objdump(1), and the Info entries for @file{binutils}.
1560 @cindex object file information
1563 @c man title objdump display information from object files.
1566 @c man begin SYNOPSIS objdump
1567 objdump [@option{-a}|@option{--archive-headers}]
1568 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1569 [@option{-C}|@option{--demangle}[=@var{style}] ]
1570 [@option{-d}|@option{--disassemble}]
1571 [@option{-D}|@option{--disassemble-all}]
1572 [@option{-z}|@option{--disassemble-zeroes}]
1573 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1574 [@option{-f}|@option{--file-headers}]
1575 [@option{-F}|@option{--file-offsets}]
1576 [@option{--file-start-context}]
1577 [@option{-g}|@option{--debugging}]
1578 [@option{-e}|@option{--debugging-tags}]
1579 [@option{-h}|@option{--section-headers}|@option{--headers}]
1580 [@option{-i}|@option{--info}]
1581 [@option{-j} @var{section}|@option{--section=}@var{section}]
1582 [@option{-l}|@option{--line-numbers}]
1583 [@option{-S}|@option{--source}]
1584 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1585 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1586 [@option{-p}|@option{--private-headers}]
1587 [@option{-r}|@option{--reloc}]
1588 [@option{-R}|@option{--dynamic-reloc}]
1589 [@option{-s}|@option{--full-contents}]
1590 [@option{-W}|@option{--dwarf}]
1591 [@option{-G}|@option{--stabs}]
1592 [@option{-t}|@option{--syms}]
1593 [@option{-T}|@option{--dynamic-syms}]
1594 [@option{-x}|@option{--all-headers}]
1595 [@option{-w}|@option{--wide}]
1596 [@option{--start-address=}@var{address}]
1597 [@option{--stop-address=}@var{address}]
1598 [@option{--prefix-addresses}]
1599 [@option{--[no-]show-raw-insn}]
1600 [@option{--adjust-vma=}@var{offset}]
1601 [@option{--special-syms}]
1602 [@option{-V}|@option{--version}]
1603 [@option{-H}|@option{--help}]
1604 @var{objfile}@dots{}
1608 @c man begin DESCRIPTION objdump
1610 @command{objdump} displays information about one or more object files.
1611 The options control what particular information to display. This
1612 information is mostly useful to programmers who are working on the
1613 compilation tools, as opposed to programmers who just want their
1614 program to compile and work.
1616 @var{objfile}@dots{} are the object files to be examined. When you
1617 specify archives, @command{objdump} shows information on each of the member
1622 @c man begin OPTIONS objdump
1624 The long and short forms of options, shown here as alternatives, are
1625 equivalent. At least one option from the list
1626 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1630 @itemx --archive-header
1631 @cindex archive headers
1632 If any of the @var{objfile} files are archives, display the archive
1633 header information (in a format similar to @samp{ls -l}). Besides the
1634 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1635 the object file format of each archive member.
1637 @item --adjust-vma=@var{offset}
1638 @cindex section addresses in objdump
1639 @cindex VMA in objdump
1640 When dumping information, first add @var{offset} to all the section
1641 addresses. This is useful if the section addresses do not correspond to
1642 the symbol table, which can happen when putting sections at particular
1643 addresses when using a format which can not represent section addresses,
1646 @item -b @var{bfdname}
1647 @itemx --target=@var{bfdname}
1648 @cindex object code format
1649 Specify that the object-code format for the object files is
1650 @var{bfdname}. This option may not be necessary; @var{objdump} can
1651 automatically recognize many formats.
1655 objdump -b oasys -m vax -h fu.o
1658 displays summary information from the section headers (@option{-h}) of
1659 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1660 file in the format produced by Oasys compilers. You can list the
1661 formats available with the @option{-i} option.
1662 @xref{Target Selection}, for more information.
1665 @itemx --demangle[=@var{style}]
1666 @cindex demangling in objdump
1667 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1668 Besides removing any initial underscore prepended by the system, this
1669 makes C++ function names readable. Different compilers have different
1670 mangling styles. The optional demangling style argument can be used to
1671 choose an appropriate demangling style for your compiler. @xref{c++filt},
1672 for more information on demangling.
1676 Display debugging information. This attempts to parse debugging
1677 information stored in the file and print it out using a C like syntax.
1678 Only certain types of debugging information have been implemented.
1679 Some other types are supported by @command{readelf -w}.
1683 @itemx --debugging-tags
1684 Like @option{-g}, but the information is generated in a format compatible
1688 @itemx --disassemble
1689 @cindex disassembling object code
1690 @cindex machine instructions
1691 Display the assembler mnemonics for the machine instructions from
1692 @var{objfile}. This option only disassembles those sections which are
1693 expected to contain instructions.
1696 @itemx --disassemble-all
1697 Like @option{-d}, but disassemble the contents of all sections, not just
1698 those expected to contain instructions.
1700 @item --prefix-addresses
1701 When disassembling, print the complete address on each line. This is
1702 the older disassembly format.
1706 @itemx --endian=@{big|little@}
1708 @cindex disassembly endianness
1709 Specify the endianness of the object files. This only affects
1710 disassembly. This can be useful when disassembling a file format which
1711 does not describe endianness information, such as S-records.
1714 @itemx --file-headers
1715 @cindex object file header
1716 Display summary information from the overall header of
1717 each of the @var{objfile} files.
1720 @itemx --file-offsets
1721 @cindex object file offsets
1722 When disassembling sections, whenever a symbol is displayed, also
1723 display the file offset of the region of data that is about to be
1724 dumped. If zeroes are being skipped, then when disassembly resumes,
1725 tell the user how many zeroes were skipped and the file offset of the
1726 location from where the disassembly resumes. When dumping sections,
1727 display the file offset of the location from where the dump starts.
1729 @item --file-start-context
1730 @cindex source code context
1731 Specify that when displaying interlisted source code/disassembly
1732 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1733 context to the start of the file.
1736 @itemx --section-headers
1738 @cindex section headers
1739 Display summary information from the section headers of the
1742 File segments may be relocated to nonstandard addresses, for example by
1743 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1744 @command{ld}. However, some object file formats, such as a.out, do not
1745 store the starting address of the file segments. In those situations,
1746 although @command{ld} relocates the sections correctly, using @samp{objdump
1747 -h} to list the file section headers cannot show the correct addresses.
1748 Instead, it shows the usual addresses, which are implicit for the
1753 Print a summary of the options to @command{objdump} and exit.
1757 @cindex architectures available
1758 @cindex object formats available
1759 Display a list showing all architectures and object formats available
1760 for specification with @option{-b} or @option{-m}.
1763 @itemx --section=@var{name}
1764 @cindex section information
1765 Display information only for section @var{name}.
1768 @itemx --line-numbers
1769 @cindex source filenames for object files
1770 Label the display (using debugging information) with the filename and
1771 source line numbers corresponding to the object code or relocs shown.
1772 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1774 @item -m @var{machine}
1775 @itemx --architecture=@var{machine}
1776 @cindex architecture
1777 @cindex disassembly architecture
1778 Specify the architecture to use when disassembling object files. This
1779 can be useful when disassembling object files which do not describe
1780 architecture information, such as S-records. You can list the available
1781 architectures with the @option{-i} option.
1783 @item -M @var{options}
1784 @itemx --disassembler-options=@var{options}
1785 Pass target specific information to the disassembler. Only supported on
1786 some targets. If it is necessary to specify more than one
1787 disassembler option then multiple @option{-M} options can be used or
1788 can be placed together into a comma separated list.
1790 If the target is an ARM architecture then this switch can be used to
1791 select which register name set is used during disassembler. Specifying
1792 @option{-M reg-names-std} (the default) will select the register names as
1793 used in ARM's instruction set documentation, but with register 13 called
1794 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1795 @option{-M reg-names-apcs} will select the name set used by the ARM
1796 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1797 just use @samp{r} followed by the register number.
1799 There are also two variants on the APCS register naming scheme enabled
1800 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1801 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1802 with the normal register names or the special register names).
1804 This option can also be used for ARM architectures to force the
1805 disassembler to interpret all instructions as Thumb instructions by
1806 using the switch @option{--disassembler-options=force-thumb}. This can be
1807 useful when attempting to disassemble thumb code produced by other
1810 For the x86, some of the options duplicate functions of the @option{-m}
1811 switch, but allow finer grained control. Multiple selections from the
1812 following may be specified as a comma separated string.
1813 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
1814 the given architecture. @option{intel} and @option{att} select between
1815 intel syntax mode and AT&T syntax mode.
1816 @option{intel-mnemonic} and @option{att-mnemonic} select between
1817 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
1818 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
1819 @option{addr64}, @option{addr32},
1820 @option{addr16}, @option{data32} and @option{data16} specify the default
1821 address size and operand size. These four options will be overridden if
1822 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
1823 option string. Lastly, @option{suffix}, when in AT&T mode,
1824 instructs the disassembler to print a mnemonic suffix even when the
1825 suffix could be inferred by the operands.
1827 For PPC, @option{booke}, @option{booke32} and @option{booke64} select
1828 disassembly of BookE instructions. @option{32} and @option{64} select
1829 PowerPC and PowerPC64 disassembly, respectively. @option{e300}
1830 selects disassembly for the e300 family. @option{440} selects
1831 disassembly for the PowerPC 440. @option{ppcps} selects disassembly
1832 for the paired single instructions of the PPC750CL.
1834 For MIPS, this option controls the printing of instruction mnemonic
1835 names and register names in disassembled instructions. Multiple
1836 selections from the following may be specified as a comma separated
1837 string, and invalid options are ignored:
1841 Print the 'raw' instruction mnemonic instead of some pseudo
1842 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
1843 'sll' instead of 'nop', etc.
1845 @item gpr-names=@var{ABI}
1846 Print GPR (general-purpose register) names as appropriate
1847 for the specified ABI. By default, GPR names are selected according to
1848 the ABI of the binary being disassembled.
1850 @item fpr-names=@var{ABI}
1851 Print FPR (floating-point register) names as
1852 appropriate for the specified ABI. By default, FPR numbers are printed
1855 @item cp0-names=@var{ARCH}
1856 Print CP0 (system control coprocessor; coprocessor 0) register names
1857 as appropriate for the CPU or architecture specified by
1858 @var{ARCH}. By default, CP0 register names are selected according to
1859 the architecture and CPU of the binary being disassembled.
1861 @item hwr-names=@var{ARCH}
1862 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1863 as appropriate for the CPU or architecture specified by
1864 @var{ARCH}. By default, HWR names are selected according to
1865 the architecture and CPU of the binary being disassembled.
1867 @item reg-names=@var{ABI}
1868 Print GPR and FPR names as appropriate for the selected ABI.
1870 @item reg-names=@var{ARCH}
1871 Print CPU-specific register names (CP0 register and HWR names)
1872 as appropriate for the selected CPU or architecture.
1875 For any of the options listed above, @var{ABI} or
1876 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
1877 rather than names, for the selected types of registers.
1878 You can list the available values of @var{ABI} and @var{ARCH} using
1879 the @option{--help} option.
1881 For VAX, you can specify function entry addresses with @option{-M
1882 entry:0xf00ba}. You can use this multiple times to properly
1883 disassemble VAX binary files that don't contain symbol tables (like
1884 ROM dumps). In these cases, the function entry mask would otherwise
1885 be decoded as VAX instructions, which would probably lead the rest
1886 of the function being wrongly disassembled.
1889 @itemx --private-headers
1890 Print information that is specific to the object file format. The exact
1891 information printed depends upon the object file format. For some
1892 object file formats, no additional information is printed.
1896 @cindex relocation entries, in object file
1897 Print the relocation entries of the file. If used with @option{-d} or
1898 @option{-D}, the relocations are printed interspersed with the
1902 @itemx --dynamic-reloc
1903 @cindex dynamic relocation entries, in object file
1904 Print the dynamic relocation entries of the file. This is only
1905 meaningful for dynamic objects, such as certain types of shared
1909 @itemx --full-contents
1910 @cindex sections, full contents
1911 @cindex object file sections
1912 Display the full contents of any sections requested. By default all
1913 non-empty sections are displayed.
1917 @cindex source disassembly
1918 @cindex disassembly, with source
1919 Display source code intermixed with disassembly, if possible. Implies
1922 @item --show-raw-insn
1923 When disassembling instructions, print the instruction in hex as well as
1924 in symbolic form. This is the default except when
1925 @option{--prefix-addresses} is used.
1927 @item --no-show-raw-insn
1928 When disassembling instructions, do not print the instruction bytes.
1929 This is the default when @option{--prefix-addresses} is used.
1934 @cindex debug symbols
1935 Displays the contents of the DWARF debug sections in the file, if any
1942 @cindex debug symbols
1943 @cindex ELF object file format
1944 Display the full contents of any sections requested. Display the
1945 contents of the .stab and .stab.index and .stab.excl sections from an
1946 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1947 @code{.stab} debugging symbol-table entries are carried in an ELF
1948 section. In most other file formats, debugging symbol-table entries are
1949 interleaved with linkage symbols, and are visible in the @option{--syms}
1952 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1953 Overview,stabs.info, The ``stabs'' debug format}.
1956 @item --start-address=@var{address}
1957 @cindex start-address
1958 Start displaying data at the specified address. This affects the output
1959 of the @option{-d}, @option{-r} and @option{-s} options.
1961 @item --stop-address=@var{address}
1962 @cindex stop-address
1963 Stop displaying data at the specified address. This affects the output
1964 of the @option{-d}, @option{-r} and @option{-s} options.
1968 @cindex symbol table entries, printing
1969 Print the symbol table entries of the file.
1970 This is similar to the information provided by the @samp{nm} program,
1971 although the display format is different. The format of the output
1972 depends upon the format of the file being dumped, but there are two main
1973 types. One looks like this:
1976 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
1977 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
1980 where the number inside the square brackets is the number of the entry
1981 in the symbol table, the @var{sec} number is the section number, the
1982 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
1983 symbol's type, the @var{scl} number is the symbol's storage class and
1984 the @var{nx} value is the number of auxilary entries associated with
1985 the symbol. The last two fields are the symbol's value and its name.
1987 The other common output format, usually seen with ELF based files,
1991 00000000 l d .bss 00000000 .bss
1992 00000000 g .text 00000000 fred
1995 Here the first number is the symbol's value (sometimes refered to as
1996 its address). The next field is actually a set of characters and
1997 spaces indicating the flag bits that are set on the symbol. These
1998 characters are described below. Next is the section with which the
1999 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2000 not connected with any section), or @emph{*UND*} if the section is
2001 referenced in the file being dumped, but not defined there.
2003 After the section name comes another field, a number, which for common
2004 symbols is the alignment and for other symbol is the size. Finally
2005 the symbol's name is displayed.
2007 The flag characters are divided into 7 groups as follows:
2012 The symbol is local (l), global (g), neither (a space) or both (!). A
2013 symbol can be neither local or global for a variety of reasons, e.g.,
2014 because it is used for debugging, but it is probably an indication of
2015 a bug if it is ever both local and global.
2018 The symbol is weak (w) or strong (a space).
2021 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2024 The symbol is a warning (W) or a normal symbol (a space). A warning
2025 symbol's name is a message to be displayed if the symbol following the
2026 warning symbol is ever referenced.
2029 The symbol is an indirect reference to another symbol (I) or a normal
2034 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2035 normal symbol (a space).
2040 The symbol is the name of a function (F) or a file (f) or an object
2041 (O) or just a normal symbol (a space).
2045 @itemx --dynamic-syms
2046 @cindex dynamic symbol table entries, printing
2047 Print the dynamic symbol table entries of the file. This is only
2048 meaningful for dynamic objects, such as certain types of shared
2049 libraries. This is similar to the information provided by the @samp{nm}
2050 program when given the @option{-D} (@option{--dynamic}) option.
2052 @item --special-syms
2053 When displaying symbols include those which the target considers to be
2054 special in some way and which would not normally be of interest to the
2059 Print the version number of @command{objdump} and exit.
2062 @itemx --all-headers
2063 @cindex all header information, object file
2064 @cindex header information, all
2065 Display all available header information, including the symbol table and
2066 relocation entries. Using @option{-x} is equivalent to specifying all of
2067 @option{-a -f -h -p -r -t}.
2071 @cindex wide output, printing
2072 Format some lines for output devices that have more than 80 columns.
2073 Also do not truncate symbol names when they are displayed.
2076 @itemx --disassemble-zeroes
2077 Normally the disassembly output will skip blocks of zeroes. This
2078 option directs the disassembler to disassemble those blocks, just like
2085 @c man begin SEEALSO objdump
2086 nm(1), readelf(1), and the Info entries for @file{binutils}.
2094 @cindex archive contents
2095 @cindex symbol index
2097 @c man title ranlib generate index to archive.
2100 @c man begin SYNOPSIS ranlib
2101 ranlib [@option{-vV}] @var{archive}
2105 @c man begin DESCRIPTION ranlib
2107 @command{ranlib} generates an index to the contents of an archive and
2108 stores it in the archive. The index lists each symbol defined by a
2109 member of an archive that is a relocatable object file.
2111 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2113 An archive with such an index speeds up linking to the library and
2114 allows routines in the library to call each other without regard to
2115 their placement in the archive.
2117 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2118 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2123 @c man begin OPTIONS ranlib
2129 Show the version number of @command{ranlib}.
2135 @c man begin SEEALSO ranlib
2136 ar(1), nm(1), and the Info entries for @file{binutils}.
2144 @cindex section sizes
2146 @c man title size list section sizes and total size.
2149 @c man begin SYNOPSIS size
2150 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2152 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2154 [@option{-t}|@option{--totals}]
2155 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2156 [@var{objfile}@dots{}]
2160 @c man begin DESCRIPTION size
2162 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2163 size---for each of the object or archive files @var{objfile} in its
2164 argument list. By default, one line of output is generated for each
2165 object file or each module in an archive.
2167 @var{objfile}@dots{} are the object files to be examined.
2168 If none are specified, the file @code{a.out} will be used.
2172 @c man begin OPTIONS size
2174 The command line options have the following meanings:
2179 @itemx --format=@var{compatibility}
2180 @cindex @command{size} display format
2181 Using one of these options, you can choose whether the output from @sc{gnu}
2182 @command{size} resembles output from System V @command{size} (using @option{-A},
2183 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2184 @option{--format=berkeley}). The default is the one-line format similar to
2186 @c Bonus for doc-source readers: you can also say --format=strange (or
2187 @c anything else that starts with 's') for sysv, and --format=boring (or
2188 @c anything else that starts with 'b') for Berkeley.
2190 Here is an example of the Berkeley (default) format of output from
2193 $ size --format=Berkeley ranlib size
2194 text data bss dec hex filename
2195 294880 81920 11592 388392 5ed28 ranlib
2196 294880 81920 11888 388688 5ee50 size
2200 This is the same data, but displayed closer to System V conventions:
2203 $ size --format=SysV ranlib size
2221 Show a summary of acceptable arguments and options.
2226 @itemx --radix=@var{number}
2227 @cindex @command{size} number format
2228 @cindex radix for section sizes
2229 Using one of these options, you can control whether the size of each
2230 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2231 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2232 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2233 values (8, 10, 16) are supported. The total size is always given in two
2234 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2235 octal and hexadecimal if you're using @option{-o}.
2238 Print total size of common symbols in each file. When using Berkeley
2239 format these are included in the bss size.
2243 Show totals of all objects listed (Berkeley format listing mode only).
2245 @item --target=@var{bfdname}
2246 @cindex object code format
2247 Specify that the object-code format for @var{objfile} is
2248 @var{bfdname}. This option may not be necessary; @command{size} can
2249 automatically recognize many formats.
2250 @xref{Target Selection}, for more information.
2254 Display the version number of @command{size}.
2260 @c man begin SEEALSO size
2261 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2268 @cindex listings strings
2269 @cindex printing strings
2270 @cindex strings, printing
2272 @c man title strings print the strings of printable characters in files.
2275 @c man begin SYNOPSIS strings
2276 strings [@option{-afov}] [@option{-}@var{min-len}]
2277 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2278 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2279 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2280 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2281 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2282 [@option{--help}] [@option{--version}] @var{file}@dots{}
2286 @c man begin DESCRIPTION strings
2288 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2289 character sequences that are at least 4 characters long (or the number
2290 given with the options below) and are followed by an unprintable
2291 character. By default, it only prints the strings from the initialized
2292 and loaded sections of object files; for other types of files, it prints
2293 the strings from the whole file.
2295 @command{strings} is mainly useful for determining the contents of non-text
2300 @c man begin OPTIONS strings
2306 Do not scan only the initialized and loaded sections of object files;
2307 scan the whole files.
2310 @itemx --print-file-name
2311 Print the name of the file before each string.
2314 Print a summary of the program usage on the standard output and exit.
2316 @item -@var{min-len}
2317 @itemx -n @var{min-len}
2318 @itemx --bytes=@var{min-len}
2319 Print sequences of characters that are at least @var{min-len} characters
2320 long, instead of the default 4.
2323 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2324 act like @samp{-t d} instead. Since we can not be compatible with both
2325 ways, we simply chose one.
2327 @item -t @var{radix}
2328 @itemx --radix=@var{radix}
2329 Print the offset within the file before each string. The single
2330 character argument specifies the radix of the offset---@samp{o} for
2331 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2333 @item -e @var{encoding}
2334 @itemx --encoding=@var{encoding}
2335 Select the character encoding of the strings that are to be found.
2336 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2337 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2338 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2339 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2340 littleendian. Useful for finding wide character strings.
2342 @item -T @var{bfdname}
2343 @itemx --target=@var{bfdname}
2344 @cindex object code format
2345 Specify an object code format other than your system's default format.
2346 @xref{Target Selection}, for more information.
2350 Print the program version number on the standard output and exit.
2356 @c man begin SEEALSO strings
2357 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2358 and the Info entries for @file{binutils}.
2366 @cindex removing symbols
2367 @cindex discarding symbols
2368 @cindex symbols, discarding
2370 @c man title strip Discard symbols from object files.
2373 @c man begin SYNOPSIS strip
2374 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2375 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2376 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2377 [@option{-s}|@option{--strip-all}]
2378 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2379 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2380 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2381 [@option{-w}|@option{--wildcard}]
2382 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2383 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2384 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2385 [@option{--keep-file-symbols}]
2386 [@option{--only-keep-debug}]
2387 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2388 [@option{--help}] [@option{--info}]
2389 @var{objfile}@dots{}
2393 @c man begin DESCRIPTION strip
2395 @sc{gnu} @command{strip} discards all symbols from object files
2396 @var{objfile}. The list of object files may include archives.
2397 At least one object file must be given.
2399 @command{strip} modifies the files named in its argument,
2400 rather than writing modified copies under different names.
2404 @c man begin OPTIONS strip
2407 @item -F @var{bfdname}
2408 @itemx --target=@var{bfdname}
2409 Treat the original @var{objfile} as a file with the object
2410 code format @var{bfdname}, and rewrite it in the same format.
2411 @xref{Target Selection}, for more information.
2414 Show a summary of the options to @command{strip} and exit.
2417 Display a list showing all architectures and object formats available.
2419 @item -I @var{bfdname}
2420 @itemx --input-target=@var{bfdname}
2421 Treat the original @var{objfile} as a file with the object
2422 code format @var{bfdname}.
2423 @xref{Target Selection}, for more information.
2425 @item -O @var{bfdname}
2426 @itemx --output-target=@var{bfdname}
2427 Replace @var{objfile} with a file in the output format @var{bfdname}.
2428 @xref{Target Selection}, for more information.
2430 @item -R @var{sectionname}
2431 @itemx --remove-section=@var{sectionname}
2432 Remove any section named @var{sectionname} from the output file. This
2433 option may be given more than once. Note that using this option
2434 inappropriately may make the output file unusable.
2443 @itemx --strip-debug
2444 Remove debugging symbols only.
2446 @item --strip-unneeded
2447 Remove all symbols that are not needed for relocation processing.
2449 @item -K @var{symbolname}
2450 @itemx --keep-symbol=@var{symbolname}
2451 When stripping symbols, keep symbol @var{symbolname} even if it would
2452 normally be stripped. This option may be given more than once.
2454 @item -N @var{symbolname}
2455 @itemx --strip-symbol=@var{symbolname}
2456 Remove symbol @var{symbolname} from the source file. This option may be
2457 given more than once, and may be combined with strip options other than
2461 Put the stripped output in @var{file}, rather than replacing the
2462 existing file. When this argument is used, only one @var{objfile}
2463 argument may be specified.
2466 @itemx --preserve-dates
2467 Preserve the access and modification dates of the file.
2471 Permit regular expressions in @var{symbolname}s used in other command
2472 line options. The question mark (?), asterisk (*), backslash (\) and
2473 square brackets ([]) operators can be used anywhere in the symbol
2474 name. If the first character of the symbol name is the exclamation
2475 point (!) then the sense of the switch is reversed for that symbol.
2482 would cause strip to only keep symbols that start with the letters
2483 ``fo'', but to discard the symbol ``foo''.
2486 @itemx --discard-all
2487 Remove non-global symbols.
2490 @itemx --discard-locals
2491 Remove compiler-generated local symbols.
2492 (These usually start with @samp{L} or @samp{.}.)
2494 @item --keep-file-symbols
2495 When stripping a file, perhaps with @option{--strip-debug} or
2496 @option{--strip-unneeded}, retain any symbols specifying source file names,
2497 which would otherwise get stripped.
2499 @item --only-keep-debug
2500 Strip a file, removing contents of any sections that would not be
2501 stripped by @option{--strip-debug} and leaving the debugging sections
2502 intact. In ELF files, this preserves all note sections in the output.
2504 The intention is that this option will be used in conjunction with
2505 @option{--add-gnu-debuglink} to create a two part executable. One a
2506 stripped binary which will occupy less space in RAM and in a
2507 distribution and the second a debugging information file which is only
2508 needed if debugging abilities are required. The suggested procedure
2509 to create these files is as follows:
2512 @item Link the executable as normal. Assuming that is is called
2514 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2515 create a file containing the debugging info.
2516 @item Run @code{objcopy --strip-debug foo} to create a
2517 stripped executable.
2518 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2519 to add a link to the debugging info into the stripped executable.
2522 Note---the choice of @code{.dbg} as an extension for the debug info
2523 file is arbitrary. Also the @code{--only-keep-debug} step is
2524 optional. You could instead do this:
2527 @item Link the executable as normal.
2528 @item Copy @code{foo} to @code{foo.full}
2529 @item Run @code{strip --strip-debug foo}
2530 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2533 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2534 full executable. It does not have to be a file created by the
2535 @option{--only-keep-debug} switch.
2537 Note---this switch is only intended for use on fully linked files. It
2538 does not make sense to use it on object files where the debugging
2539 information may be incomplete. Besides the gnu_debuglink feature
2540 currently only supports the presence of one filename containing
2541 debugging information, not multiple filenames on a one-per-object-file
2546 Show the version number for @command{strip}.
2550 Verbose output: list all object files modified. In the case of
2551 archives, @samp{strip -v} lists all members of the archive.
2557 @c man begin SEEALSO strip
2558 the Info entries for @file{binutils}.
2562 @node c++filt, addr2line, strip, Top
2566 @cindex demangling C++ symbols
2568 @c man title cxxfilt Demangle C++ and Java symbols.
2571 @c man begin SYNOPSIS cxxfilt
2572 c++filt [@option{-_}|@option{--strip-underscores}]
2573 [@option{-n}|@option{--no-strip-underscores}]
2574 [@option{-p}|@option{--no-params}]
2575 [@option{-t}|@option{--types}]
2576 [@option{-i}|@option{--no-verbose}]
2577 [@option{-s} @var{format}|@option{--format=}@var{format}]
2578 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2582 @c man begin DESCRIPTION cxxfilt
2585 The C++ and Java languages provide function overloading, which means
2586 that you can write many functions with the same name, providing that
2587 each function takes parameters of different types. In order to be
2588 able to distinguish these similarly named functions C++ and Java
2589 encode them into a low-level assembler name which uniquely identifies
2590 each different version. This process is known as @dfn{mangling}. The
2592 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2593 MS-DOS this program is named @command{CXXFILT}.}
2594 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2595 names into user-level names so that they can be read.
2597 Every alphanumeric word (consisting of letters, digits, underscores,
2598 dollars, or periods) seen in the input is a potential mangled name.
2599 If the name decodes into a C++ name, the C++ name replaces the
2600 low-level name in the output, otherwise the original word is output.
2601 In this way you can pass an entire assembler source file, containing
2602 mangled names, through @command{c++filt} and see the same source file
2603 containing demangled names.
2605 You can also use @command{c++filt} to decipher individual symbols by
2606 passing them on the command line:
2609 c++filt @var{symbol}
2612 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2613 names from the standard input instead. All the results are printed on
2614 the standard output. The difference between reading names from the
2615 command line versus reading names from the standard input is that
2616 command line arguments are expected to be just mangled names and no
2617 checking is performed to separate them from surrounding text. Thus
2624 will work and demangle the name to ``f()'' whereas:
2630 will not work. (Note the extra comma at the end of the mangled
2631 name which makes it invalid). This command however will work:
2634 echo _Z1fv, | c++filt -n
2637 and will display ``f(),'', i.e., the demangled name followed by a
2638 trailing comma. This behaviour is because when the names are read
2639 from the standard input it is expected that they might be part of an
2640 assembler source file where there might be extra, extraneous
2641 characters trailing after a mangled name. For example:
2644 .type _Z1fv, @@function
2649 @c man begin OPTIONS cxxfilt
2653 @itemx --strip-underscores
2654 On some systems, both the C and C++ compilers put an underscore in front
2655 of every name. For example, the C name @code{foo} gets the low-level
2656 name @code{_foo}. This option removes the initial underscore. Whether
2657 @command{c++filt} removes the underscore by default is target dependent.
2661 Prints demangled names using Java syntax. The default is to use C++
2665 @itemx --no-strip-underscores
2666 Do not remove the initial underscore.
2670 When demangling the name of a function, do not display the types of
2671 the function's parameters.
2675 Attempt to demangle types as well as function names. This is disabled
2676 by default since mangled types are normally only used internally in
2677 the compiler, and they can be confused with non-mangled names. For example,
2678 a function called ``a'' treated as a mangled type name would be
2679 demangled to ``signed char''.
2683 Do not include implementation details (if any) in the demangled
2686 @item -s @var{format}
2687 @itemx --format=@var{format}
2688 @command{c++filt} can decode various methods of mangling, used by
2689 different compilers. The argument to this option selects which
2694 Automatic selection based on executable (the default method)
2696 the one used by the @sc{gnu} C++ compiler (g++)
2698 the one used by the Lucid compiler (lcc)
2700 the one specified by the C++ Annotated Reference Manual
2702 the one used by the HP compiler (aCC)
2704 the one used by the EDG compiler
2706 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2708 the one used by the @sc{gnu} Java compiler (gcj)
2710 the one used by the @sc{gnu} Ada compiler (GNAT).
2714 Print a summary of the options to @command{c++filt} and exit.
2717 Print the version number of @command{c++filt} and exit.
2723 @c man begin SEEALSO cxxfilt
2724 the Info entries for @file{binutils}.
2729 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2730 user interface are subject to change in future releases. In particular,
2731 a command-line option may be required in the future to decode a name
2732 passed as an argument on the command line; in other words,
2735 c++filt @var{symbol}
2739 may in a future release become
2742 c++filt @var{option} @var{symbol}
2750 @cindex address to file name and line number
2752 @c man title addr2line convert addresses into file names and line numbers.
2755 @c man begin SYNOPSIS addr2line
2756 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2757 [@option{-C}|@option{--demangle}[=@var{style}]]
2758 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2759 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2760 [@option{-i}|@option{--inlines}]
2761 [@option{-j}|@option{--section=}@var{name}]
2762 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2767 @c man begin DESCRIPTION addr2line
2769 @command{addr2line} translates addresses into file names and line numbers.
2770 Given an address in an executable or an offset in a section of a relocatable
2771 object, it uses the debugging information to figure out which file name and
2772 line number are associated with it.
2774 The executable or relocatable object to use is specified with the @option{-e}
2775 option. The default is the file @file{a.out}. The section in the relocatable
2776 object to use is specified with the @option{-j} option.
2778 @command{addr2line} has two modes of operation.
2780 In the first, hexadecimal addresses are specified on the command line,
2781 and @command{addr2line} displays the file name and line number for each
2784 In the second, @command{addr2line} reads hexadecimal addresses from
2785 standard input, and prints the file name and line number for each
2786 address on standard output. In this mode, @command{addr2line} may be used
2787 in a pipe to convert dynamically chosen addresses.
2789 The format of the output is @samp{FILENAME:LINENO}. The file name and
2790 line number for each address is printed on a separate line. If the
2791 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2792 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2793 containing the address.
2795 If the file name or function name can not be determined,
2796 @command{addr2line} will print two question marks in their place. If the
2797 line number can not be determined, @command{addr2line} will print 0.
2801 @c man begin OPTIONS addr2line
2803 The long and short forms of options, shown here as alternatives, are
2807 @item -b @var{bfdname}
2808 @itemx --target=@var{bfdname}
2809 @cindex object code format
2810 Specify that the object-code format for the object files is
2814 @itemx --demangle[=@var{style}]
2815 @cindex demangling in objdump
2816 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2817 Besides removing any initial underscore prepended by the system, this
2818 makes C++ function names readable. Different compilers have different
2819 mangling styles. The optional demangling style argument can be used to
2820 choose an appropriate demangling style for your compiler. @xref{c++filt},
2821 for more information on demangling.
2823 @item -e @var{filename}
2824 @itemx --exe=@var{filename}
2825 Specify the name of the executable for which addresses should be
2826 translated. The default file is @file{a.out}.
2830 Display function names as well as file and line number information.
2834 Display only the base of each file name.
2838 If the address belongs to a function that was inlined, the source
2839 information for all enclosing scopes back to the first non-inlined
2840 function will also be printed. For example, if @code{main} inlines
2841 @code{callee1} which inlines @code{callee2}, and address is from
2842 @code{callee2}, the source information for @code{callee1} and @code{main}
2843 will also be printed.
2847 Read offsets relative to the specified section instead of absolute addresses.
2853 @c man begin SEEALSO addr2line
2854 Info entries for @file{binutils}.
2861 @command{nlmconv} converts a relocatable object file into a NetWare
2865 @command{nlmconv} currently works with @samp{i386} object
2866 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2867 object files in @sc{elf}, or @code{a.out} format@footnote{
2868 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2869 format in the Binary File Descriptor library. It has only been tested
2870 with the above formats.}.
2874 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2875 utilities, since it is only useful for NLM targets.
2878 @c man title nlmconv converts object code into an NLM.
2881 @c man begin SYNOPSIS nlmconv
2882 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2883 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2884 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2885 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2886 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2887 @var{infile} @var{outfile}
2891 @c man begin DESCRIPTION nlmconv
2893 @command{nlmconv} converts the relocatable @samp{i386} object file
2894 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2895 reading @var{headerfile} for NLM header information. For instructions
2896 on writing the NLM command file language used in header files, see the
2897 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2898 Development and Tools Overview}, which is part of the NLM Software
2899 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2900 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2903 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2906 @command{nlmconv} can perform a link step. In other words, you can list
2907 more than one object file for input if you list them in the definitions
2908 file (rather than simply specifying one input file on the command line).
2909 In this case, @command{nlmconv} calls the linker for you.
2913 @c man begin OPTIONS nlmconv
2916 @item -I @var{bfdname}
2917 @itemx --input-target=@var{bfdname}
2918 Object format of the input file. @command{nlmconv} can usually determine
2919 the format of a given file (so no default is necessary).
2920 @xref{Target Selection}, for more information.
2922 @item -O @var{bfdname}
2923 @itemx --output-target=@var{bfdname}
2924 Object format of the output file. @command{nlmconv} infers the output
2925 format based on the input format, e.g. for a @samp{i386} input file the
2926 output format is @samp{nlm32-i386}.
2927 @xref{Target Selection}, for more information.
2929 @item -T @var{headerfile}
2930 @itemx --header-file=@var{headerfile}
2931 Reads @var{headerfile} for NLM header information. For instructions on
2932 writing the NLM command file language used in header files, see@ see the
2933 @samp{linkers} section, of the @cite{NLM Development and Tools
2934 Overview}, which is part of the NLM Software Developer's Kit, available
2939 Displays (on standard error) the linker command line used by @command{nlmconv}.
2941 @item -l @var{linker}
2942 @itemx --linker=@var{linker}
2943 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2948 Prints a usage summary.
2952 Prints the version number for @command{nlmconv}.
2958 @c man begin SEEALSO nlmconv
2959 the Info entries for @file{binutils}.
2966 @command{windmc} may be used to generator Windows message resources.
2969 @emph{Warning:} @command{windmc} is not always built as part of the binary
2970 utilities, since it is only useful for Windows targets.
2973 @c man title windmc generates Windows message resources.
2976 @c man begin SYNOPSIS windres
2977 windmc [options] input-file
2981 @c man begin DESCRIPTION windmc
2983 @command{windmc} reads message definitions from an input file (.mc) and
2984 translate them into a set of output files. The output files may be of
2989 A C header file containing the message definitions.
2992 A resource file compilable by the @command{windres} tool.
2995 One or more binary files containing the resource data for a specific
2999 A C include file that maps message id's to their symbolic name.
3002 The exact description of these different formats is available in
3003 documentation from Microsoft.
3005 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3006 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3007 Windows Message Compiler.
3011 @c man begin OPTIONS windmc
3016 Specifies that the input file specified is ANSI. This is the default
3021 Specifies that messages in the output @code{bin} files should be in ANSI
3026 Specifies that @code{bin} filenames should have to be prefixed by the
3027 basename of the source file.
3031 Sets the customer bit in all message id's.
3033 @item -C @var{codepage}
3034 @itemx --codepage_in @var{codepage}
3035 Sets the default codepage to be used to convert input file to UTF16. The
3036 default is ocdepage 1252.
3039 @itemx --decimal_values
3040 Outputs the constants in the header file in decimal. Default is using
3044 @itemx --extension @var{ext}
3045 The extension for the header file. The default is .h extension.
3047 @item -F @var{target}
3048 @itemx --target @var{target}
3049 Specify the BFD format to use for a bin file as output. This
3050 is a BFD target name; you can use the @option{--help} option to see a list
3051 of supported targets. Normally @command{windmc} will use the default
3052 format, which is the first one listed by the @option{--help} option.
3054 @ref{Target Selection}.
3058 @itemx --headerdir @var{path}
3059 The target directory of the generated header file. The default is the
3064 Displays a list of command line options and then exits.
3066 @item -m @var{characters}
3067 @itemx --maxlength @var{characters}
3068 Instructs @command{windmc} to generate a warning if the length
3069 of any message exceeds the number specified.
3072 @itemx --nullterminate
3073 Terminate message text in @code{bin} files by zero. By default they are
3074 terminated by CR/LF.
3077 @itemx --hresult_use
3078 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3079 file, using HRESULT definitions. Status codes are used if the flag is not
3082 @item -O @var{codepage}
3083 @itemx --codepage_out @var{codepage}
3084 Sets the default codepage to be used to output text files. The default
3088 @itemx --rcdir @var{path}
3089 The target directory for the generated @code{rc} script and the generated
3090 @code{bin} files that the resource compiler script includes. The default
3091 is the current directory.
3095 Specifies that the input file is UTF16.
3098 @itemx --unicode_out
3099 Specifies that messages in the output @code{bin} file should be in UTF16
3100 format. This is the default behaviour.
3104 Enable verbose mode.
3108 Prints the version number for @command{windmc}.
3111 @itemx --xdgb @var{path}
3112 The path of the @code{dbg} C include file that maps message id's to the
3113 symbolic name. No such file is generated without specifying the switch.
3119 @c man begin SEEALSO windmc
3120 the Info entries for @file{binutils}.
3127 @command{windres} may be used to manipulate Windows resources.
3130 @emph{Warning:} @command{windres} is not always built as part of the binary
3131 utilities, since it is only useful for Windows targets.
3134 @c man title windres manipulate Windows resources.
3137 @c man begin SYNOPSIS windres
3138 windres [options] [input-file] [output-file]
3142 @c man begin DESCRIPTION windres
3144 @command{windres} reads resources from an input file and copies them into
3145 an output file. Either file may be in one of three formats:
3149 A text format read by the Resource Compiler.
3152 A binary format generated by the Resource Compiler.
3155 A COFF object or executable.
3158 The exact description of these different formats is available in
3159 documentation from Microsoft.
3161 When @command{windres} converts from the @code{rc} format to the @code{res}
3162 format, it is acting like the Windows Resource Compiler. When
3163 @command{windres} converts from the @code{res} format to the @code{coff}
3164 format, it is acting like the Windows @code{CVTRES} program.
3166 When @command{windres} generates an @code{rc} file, the output is similar
3167 but not identical to the format expected for the input. When an input
3168 @code{rc} file refers to an external filename, an output @code{rc} file
3169 will instead include the file contents.
3171 If the input or output format is not specified, @command{windres} will
3172 guess based on the file name, or, for the input file, the file contents.
3173 A file with an extension of @file{.rc} will be treated as an @code{rc}
3174 file, a file with an extension of @file{.res} will be treated as a
3175 @code{res} file, and a file with an extension of @file{.o} or
3176 @file{.exe} will be treated as a @code{coff} file.
3178 If no output file is specified, @command{windres} will print the resources
3179 in @code{rc} format to standard output.
3181 The normal use is for you to write an @code{rc} file, use @command{windres}
3182 to convert it to a COFF object file, and then link the COFF file into
3183 your application. This will make the resources described in the
3184 @code{rc} file available to Windows.
3188 @c man begin OPTIONS windres
3191 @item -i @var{filename}
3192 @itemx --input @var{filename}
3193 The name of the input file. If this option is not used, then
3194 @command{windres} will use the first non-option argument as the input file
3195 name. If there are no non-option arguments, then @command{windres} will
3196 read from standard input. @command{windres} can not read a COFF file from
3199 @item -o @var{filename}
3200 @itemx --output @var{filename}
3201 The name of the output file. If this option is not used, then
3202 @command{windres} will use the first non-option argument, after any used
3203 for the input file name, as the output file name. If there is no
3204 non-option argument, then @command{windres} will write to standard output.
3205 @command{windres} can not write a COFF file to standard output. Note,
3206 for compatibility with @command{rc} the option @option{-fo} is also
3207 accepted, but its use is not recommended.
3209 @item -J @var{format}
3210 @itemx --input-format @var{format}
3211 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3212 @samp{coff}. If no input format is specified, @command{windres} will
3213 guess, as described above.
3215 @item -O @var{format}
3216 @itemx --output-format @var{format}
3217 The output format to generate. @var{format} may be @samp{res},
3218 @samp{rc}, or @samp{coff}. If no output format is specified,
3219 @command{windres} will guess, as described above.
3221 @item -F @var{target}
3222 @itemx --target @var{target}
3223 Specify the BFD format to use for a COFF file as input or output. This
3224 is a BFD target name; you can use the @option{--help} option to see a list
3225 of supported targets. Normally @command{windres} will use the default
3226 format, which is the first one listed by the @option{--help} option.
3228 @ref{Target Selection}.
3231 @item --preprocessor @var{program}
3232 When @command{windres} reads an @code{rc} file, it runs it through the C
3233 preprocessor first. This option may be used to specify the preprocessor
3234 to use, including any leading arguments. The default preprocessor
3235 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3237 @item -I @var{directory}
3238 @itemx --include-dir @var{directory}
3239 Specify an include directory to use when reading an @code{rc} file.
3240 @command{windres} will pass this to the preprocessor as an @option{-I}
3241 option. @command{windres} will also search this directory when looking for
3242 files named in the @code{rc} file. If the argument passed to this command
3243 matches any of the supported @var{formats} (as described in the @option{-J}
3244 option), it will issue a deprecation warning, and behave just like the
3245 @option{-J} option. New programs should not use this behaviour. If a
3246 directory happens to match a @var{format}, simple prefix it with @samp{./}
3247 to disable the backward compatibility.
3249 @item -D @var{target}
3250 @itemx --define @var{sym}[=@var{val}]
3251 Specify a @option{-D} option to pass to the preprocessor when reading an
3254 @item -U @var{target}
3255 @itemx --undefine @var{sym}
3256 Specify a @option{-U} option to pass to the preprocessor when reading an
3260 Ignored for compatibility with rc.
3263 Enable verbose mode. This tells you what the preprocessor is if you
3267 @item --codepage @var{val}
3268 Specify the default codepage to use when reading an @code{rc} file.
3269 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3270 codepage code. The valid range is from zero up to 0xffff, but the
3271 validity of the codepage is host and configuration dependent.
3274 @item --language @var{val}
3275 Specify the default language to use when reading an @code{rc} file.
3276 @var{val} should be a hexadecimal language code. The low eight bits are
3277 the language, and the high eight bits are the sublanguage.
3279 @item --use-temp-file
3280 Use a temporary file to instead of using popen to read the output of
3281 the preprocessor. Use this option if the popen implementation is buggy
3282 on the host (eg., certain non-English language versions of Windows 95 and
3283 Windows 98 are known to have buggy popen where the output will instead
3286 @item --no-use-temp-file
3287 Use popen, not a temporary file, to read the output of the preprocessor.
3288 This is the default behaviour.
3292 Prints a usage summary.
3296 Prints the version number for @command{windres}.
3299 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3300 this will turn on parser debugging.
3306 @c man begin SEEALSO windres
3307 the Info entries for @file{binutils}.
3316 @command{dlltool} is used to create the files needed to create dynamic
3317 link libraries (DLLs) on systems which understand PE format image
3318 files such as Windows. A DLL contains an export table which contains
3319 information that the runtime loader needs to resolve references from a
3320 referencing program.
3322 The export table is generated by this program by reading in a
3323 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3324 will be in the DLL. A @file{.o} file can contain information in
3325 special @samp{.drectve} sections with export information.
3328 @emph{Note:} @command{dlltool} is not always built as part of the
3329 binary utilities, since it is only useful for those targets which
3333 @c man title dlltool Create files needed to build and use DLLs.
3336 @c man begin SYNOPSIS dlltool
3337 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3338 [@option{-b}|@option{--base-file} @var{base-file-name}]
3339 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3340 [@option{-z}|@option{--output-def} @var{def-file-name}]
3341 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3342 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3343 [@option{--exclude-symbols} @var{list}]
3344 [@option{--no-default-excludes}]
3345 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3346 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3347 [@option{-a}|@option{--add-indirect}]
3348 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3349 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3350 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3351 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}]
3352 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3353 [@option{-v}|@option{--verbose}]
3354 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3355 [object-file @dots{}]
3359 @c man begin DESCRIPTION dlltool
3361 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3362 @option{-b} options as well as object files specified on the command
3363 line. It then processes these inputs and if the @option{-e} option has
3364 been specified it creates a exports file. If the @option{-l} option
3365 has been specified it creates a library file and if the @option{-z} option
3366 has been specified it creates a def file. Any or all of the @option{-e},
3367 @option{-l} and @option{-z} options can be present in one invocation of
3370 When creating a DLL, along with the source for the DLL, it is necessary
3371 to have three other files. @command{dlltool} can help with the creation of
3374 The first file is a @file{.def} file which specifies which functions are
3375 exported from the DLL, which functions the DLL imports, and so on. This
3376 is a text file and can be created by hand, or @command{dlltool} can be used
3377 to create it using the @option{-z} option. In this case @command{dlltool}
3378 will scan the object files specified on its command line looking for
3379 those functions which have been specially marked as being exported and
3380 put entries for them in the @file{.def} file it creates.
3382 In order to mark a function as being exported from a DLL, it needs to
3383 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3384 section of the object file. This can be done in C by using the
3388 asm (".section .drectve");
3389 asm (".ascii \"-export:my_func\"");
3391 int my_func (void) @{ @dots{} @}
3394 The second file needed for DLL creation is an exports file. This file
3395 is linked with the object files that make up the body of the DLL and it
3396 handles the interface between the DLL and the outside world. This is a
3397 binary file and it can be created by giving the @option{-e} option to
3398 @command{dlltool} when it is creating or reading in a @file{.def} file.
3400 The third file needed for DLL creation is the library file that programs
3401 will link with in order to access the functions in the DLL. This file
3402 can be created by giving the @option{-l} option to dlltool when it
3403 is creating or reading in a @file{.def} file.
3405 @command{dlltool} builds the library file by hand, but it builds the
3406 exports file by creating temporary files containing assembler statements
3407 and then assembling these. The @option{-S} command line option can be
3408 used to specify the path to the assembler that dlltool will use,
3409 and the @option{-f} option can be used to pass specific flags to that
3410 assembler. The @option{-n} can be used to prevent dlltool from deleting
3411 these temporary assembler files when it is done, and if @option{-n} is
3412 specified twice then this will prevent dlltool from deleting the
3413 temporary object files it used to build the library.
3415 Here is an example of creating a DLL from a source file @samp{dll.c} and
3416 also creating a program (from an object file called @samp{program.o})
3421 dlltool -e exports.o -l dll.lib dll.o
3422 gcc dll.o exports.o -o dll.dll
3423 gcc program.o dll.lib -o program
3428 @c man begin OPTIONS dlltool
3430 The command line options have the following meanings:
3434 @item -d @var{filename}
3435 @itemx --input-def @var{filename}
3436 @cindex input .def file
3437 Specifies the name of a @file{.def} file to be read in and processed.
3439 @item -b @var{filename}
3440 @itemx --base-file @var{filename}
3442 Specifies the name of a base file to be read in and processed. The
3443 contents of this file will be added to the relocation section in the
3444 exports file generated by dlltool.
3446 @item -e @var{filename}
3447 @itemx --output-exp @var{filename}
3448 Specifies the name of the export file to be created by dlltool.
3450 @item -z @var{filename}
3451 @itemx --output-def @var{filename}
3452 Specifies the name of the @file{.def} file to be created by dlltool.
3454 @item -l @var{filename}
3455 @itemx --output-lib @var{filename}
3456 Specifies the name of the library file to be created by dlltool.
3458 @item --export-all-symbols
3459 Treat all global and weak defined symbols found in the input object
3460 files as symbols to be exported. There is a small list of symbols which
3461 are not exported by default; see the @option{--no-default-excludes}
3462 option. You may add to the list of symbols to not export by using the
3463 @option{--exclude-symbols} option.
3465 @item --no-export-all-symbols
3466 Only export symbols explicitly listed in an input @file{.def} file or in
3467 @samp{.drectve} sections in the input object files. This is the default
3468 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3469 attributes in the source code.
3471 @item --exclude-symbols @var{list}
3472 Do not export the symbols in @var{list}. This is a list of symbol names
3473 separated by comma or colon characters. The symbol names should not
3474 contain a leading underscore. This is only meaningful when
3475 @option{--export-all-symbols} is used.
3477 @item --no-default-excludes
3478 When @option{--export-all-symbols} is used, it will by default avoid
3479 exporting certain special symbols. The current list of symbols to avoid
3480 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3481 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3482 to go ahead and export these special symbols. This is only meaningful
3483 when @option{--export-all-symbols} is used.
3486 @itemx --as @var{path}
3487 Specifies the path, including the filename, of the assembler to be used
3488 to create the exports file.
3490 @item -f @var{options}
3491 @itemx --as-flags @var{options}
3492 Specifies any specific command line options to be passed to the
3493 assembler when building the exports file. This option will work even if
3494 the @option{-S} option is not used. This option only takes one argument,
3495 and if it occurs more than once on the command line, then later
3496 occurrences will override earlier occurrences. So if it is necessary to
3497 pass multiple options to the assembler they should be enclosed in
3501 @itemx --dll-name @var{name}
3502 Specifies the name to be stored in the @file{.def} file as the name of
3503 the DLL when the @option{-e} option is used. If this option is not
3504 present, then the filename given to the @option{-e} option will be
3505 used as the name of the DLL.
3507 @item -m @var{machine}
3508 @itemx -machine @var{machine}
3509 Specifies the type of machine for which the library file should be
3510 built. @command{dlltool} has a built in default type, depending upon how
3511 it was created, but this option can be used to override that. This is
3512 normally only useful when creating DLLs for an ARM processor, when the
3513 contents of the DLL are actually encode using Thumb instructions.
3516 @itemx --add-indirect
3517 Specifies that when @command{dlltool} is creating the exports file it
3518 should add a section which allows the exported functions to be
3519 referenced without using the import library. Whatever the hell that
3523 @itemx --add-underscore
3524 Specifies that when @command{dlltool} is creating the exports file it
3525 should prepend an underscore to the names of @emph{all} exported symbols.
3527 @item --add-stdcall-underscore
3528 Specifies that when @command{dlltool} is creating the exports file it
3529 should prepend an underscore to the names of exported @emph{stdcall}
3530 functions. Variable names and non-stdcall function names are not modified.
3531 This option is useful when creating GNU-compatible import libs for third
3532 party DLLs that were built with MS-Windows tools.
3536 Specifies that when @command{dlltool} is creating the exports file it
3537 should not append the string @samp{@@ <number>}. These numbers are
3538 called ordinal numbers and they represent another way of accessing the
3539 function in a DLL, other than by name.
3542 @itemx --add-stdcall-alias
3543 Specifies that when @command{dlltool} is creating the exports file it
3544 should add aliases for stdcall symbols without @samp{@@ <number>}
3545 in addition to the symbols with @samp{@@ <number>}.
3548 @itemx --ext-prefix-alias @var{prefix}
3549 Causes @command{dlltool} to create external aliases for all DLL
3550 imports with the specified prefix. The aliases are created for both
3551 external and import symbols with no leading underscore.
3555 Specifies that when @command{dlltool} is creating the exports and library
3556 files it should omit the @code{.idata4} section. This is for compatibility
3557 with certain operating systems.
3561 Specifies that when @command{dlltool} is creating the exports and library
3562 files it should omit the @code{.idata5} section. This is for compatibility
3563 with certain operating systems.
3567 Specifies that @command{dlltool} should mark the objects in the library
3568 file and exports file that it produces as supporting interworking
3569 between ARM and Thumb code.
3573 Makes @command{dlltool} preserve the temporary assembler files it used to
3574 create the exports file. If this option is repeated then dlltool will
3575 also preserve the temporary object files it uses to create the library
3578 @item -t @var{prefix}
3579 @itemx --temp-prefix @var{prefix}
3580 Makes @command{dlltool} use @var{prefix} when constructing the names of
3581 temporary assembler and object files. By default, the temp file prefix
3582 is generated from the pid.
3586 Make dlltool describe what it is doing.
3590 Displays a list of command line options and then exits.
3594 Displays dlltool's version number and then exits.
3601 * def file format:: The format of the dlltool @file{.def} file
3604 @node def file format
3605 @section The format of the @command{dlltool} @file{.def} file
3607 A @file{.def} file contains any number of the following commands:
3611 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3612 The result is going to be named @var{name}@code{.exe}.
3614 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3615 The result is going to be named @var{name}@code{.dll}.
3617 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3618 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3619 Declares @var{name1} as an exported symbol from the DLL, with optional
3620 ordinal number @var{integer}, or declares @var{name1} as an alias
3621 (forward) of the function @var{external-name} in the DLL
3624 @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{) ) *}
3625 Declares that @var{external-name} or the exported function whose
3626 ordinal number is @var{integer} is to be imported from the file
3627 @var{module-name}. If @var{internal-name} is specified then this is
3628 the name that the imported function will be referred to in the body of
3631 @item @code{DESCRIPTION} @var{string}
3632 Puts @var{string} into the output @file{.exp} file in the
3633 @code{.rdata} section.
3635 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3636 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3637 Generates @code{--stack} or @code{--heap}
3638 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
3639 section. The linker will see this and act upon it.
3641 @item @code{CODE} @var{attr} @code{+}
3642 @item @code{DATA} @var{attr} @code{+}
3643 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3644 Generates @code{--attr} @var{section-name} @var{attr} in the output
3645 @code{.drectve} section, where @var{attr} is one of @code{READ},
3646 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3647 this and act upon it.
3652 @c man begin SEEALSO dlltool
3653 The Info pages for @file{binutils}.
3660 @cindex ELF file information
3663 @c man title readelf Displays information about ELF files.
3666 @c man begin SYNOPSIS readelf
3667 readelf [@option{-a}|@option{--all}]
3668 [@option{-h}|@option{--file-header}]
3669 [@option{-l}|@option{--program-headers}|@option{--segments}]
3670 [@option{-S}|@option{--section-headers}|@option{--sections}]
3671 [@option{-g}|@option{--section-groups}]
3672 [@option{-t}|@option{--section-details}]
3673 [@option{-e}|@option{--headers}]
3674 [@option{-s}|@option{--syms}|@option{--symbols}]
3675 [@option{-n}|@option{--notes}]
3676 [@option{-r}|@option{--relocs}]
3677 [@option{-u}|@option{--unwind}]
3678 [@option{-d}|@option{--dynamic}]
3679 [@option{-V}|@option{--version-info}]
3680 [@option{-A}|@option{--arch-specific}]
3681 [@option{-D}|@option{--use-dynamic}]
3682 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
3683 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
3684 [@option{-c}|@option{--archive-index}]
3685 [@option{-w[liaprmfFsoR]}|
3686 @option{--debug-dump}[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
3687 [@option{-I}|@option{-histogram}]
3688 [@option{-v}|@option{--version}]
3689 [@option{-W}|@option{--wide}]
3690 [@option{-H}|@option{--help}]
3691 @var{elffile}@dots{}
3695 @c man begin DESCRIPTION readelf
3697 @command{readelf} displays information about one or more ELF format object
3698 files. The options control what particular information to display.
3700 @var{elffile}@dots{} are the object files to be examined. 32-bit and
3701 64-bit ELF files are supported, as are archives containing ELF files.
3703 This program performs a similar function to @command{objdump} but it
3704 goes into more detail and it exists independently of the @sc{bfd}
3705 library, so if there is a bug in @sc{bfd} then readelf will not be
3710 @c man begin OPTIONS readelf
3712 The long and short forms of options, shown here as alternatives, are
3713 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3719 Equivalent to specifying @option{--file-header},
3720 @option{--program-headers}, @option{--sections}, @option{--symbols},
3721 @option{--relocs}, @option{--dynamic}, @option{--notes} and
3722 @option{--version-info}.
3725 @itemx --file-header
3726 @cindex ELF file header information
3727 Displays the information contained in the ELF header at the start of the
3731 @itemx --program-headers
3733 @cindex ELF program header information
3734 @cindex ELF segment information
3735 Displays the information contained in the file's segment headers, if it
3740 @itemx --section-headers
3741 @cindex ELF section information
3742 Displays the information contained in the file's section headers, if it
3746 @itemx --section-groups
3747 @cindex ELF section group information
3748 Displays the information contained in the file's section groups, if it
3752 @itemx --section-details
3753 @cindex ELF section information
3754 Displays the detailed section information. Implies @option{-S}.
3759 @cindex ELF symbol table information
3760 Displays the entries in symbol table section of the file, if it has one.
3764 Display all the headers in the file. Equivalent to @option{-h -l -S}.
3769 Displays the contents of the NOTE segments and/or sections, if any.
3773 @cindex ELF reloc information
3774 Displays the contents of the file's relocation section, if it has one.
3778 @cindex unwind information
3779 Displays the contents of the file's unwind section, if it has one. Only
3780 the unwind sections for IA64 ELF files are currently supported.
3784 @cindex ELF dynamic section information
3785 Displays the contents of the file's dynamic section, if it has one.
3788 @itemx --version-info
3789 @cindex ELF version sections informations
3790 Displays the contents of the version sections in the file, it they
3794 @itemx --arch-specific
3795 Displays architecture-specific information in the file, if there
3799 @itemx --use-dynamic
3800 When displaying symbols, this option makes @command{readelf} use the
3801 symbol table in the file's dynamic section, rather than the one in the
3804 @item -x <number or name>
3805 @itemx --hex-dump=<number or name>
3806 Displays the contents of the indicated section as a hexadecimal dump.
3807 A number identifies a particular section by index in the section table;
3808 any other string identifies all sections with that name in the object file.
3810 @item -p <number or name>
3811 @itemx --string-dump=<number or name>
3812 Displays the contents of the indicated section as printable strings.
3813 A number identifies a particular section by index in the section table;
3814 any other string identifies all sections with that name in the object file.
3817 @itemx --archive-index
3818 @cindex Archive file symbol index information
3819 Displays the file symbol index infomation contained in the header part
3820 of binary archives. Performs the same function as the @option{t}
3821 command to @command{ar}, but without using the BFD library. @xref{ar}.
3823 @item -w[liaprmfFsoR]
3824 @itemx --debug-dump[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
3825 Displays the contents of the debug sections in the file, if any are
3826 present. If one of the optional letters or words follows the switch
3827 then only data found in those specific sections will be dumped.
3831 Display a histogram of bucket list lengths when displaying the contents
3832 of the symbol tables.
3836 Display the version number of readelf.
3840 Don't break output lines to fit into 80 columns. By default
3841 @command{readelf} breaks section header and segment listing lines for
3842 64-bit ELF files, so that they fit into 80 columns. This option causes
3843 @command{readelf} to print each section header resp. each segment one a
3844 single line, which is far more readable on terminals wider than 80 columns.
3848 Display the command line options understood by @command{readelf}.
3855 @c man begin SEEALSO readelf
3856 objdump(1), and the Info entries for @file{binutils}.
3860 @node Common Options
3861 @chapter Common Options
3863 The following command-line options are supported by all of the
3864 programs described in this manual.
3866 @c man begin OPTIONS
3868 @include at-file.texi
3872 Display the command-line options supported by the program.
3875 Display the version number of the program.
3877 @c man begin OPTIONS
3881 @node Selecting the Target System
3882 @chapter Selecting the Target System
3884 You can specify two aspects of the target system to the @sc{gnu}
3885 binary file utilities, each in several ways:
3895 In the following summaries, the lists of ways to specify values are in
3896 order of decreasing precedence. The ways listed first override those
3899 The commands to list valid values only list the values for which the
3900 programs you are running were configured. If they were configured with
3901 @option{--enable-targets=all}, the commands list most of the available
3902 values, but a few are left out; not all targets can be configured in at
3903 once because some of them can only be configured @dfn{native} (on hosts
3904 with the same type as the target system).
3907 * Target Selection::
3908 * Architecture Selection::
3911 @node Target Selection
3912 @section Target Selection
3914 A @dfn{target} is an object file format. A given target may be
3915 supported for multiple architectures (@pxref{Architecture Selection}).
3916 A target selection may also have variations for different operating
3917 systems or architectures.
3919 The command to list valid target values is @samp{objdump -i}
3920 (the first column of output contains the relevant information).
3922 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
3923 @samp{a.out-sunos-big}.
3925 You can also specify a target using a configuration triplet. This is
3926 the same sort of name that is passed to @file{configure} to specify a
3927 target. When you use a configuration triplet as an argument, it must be
3928 fully canonicalized. You can see the canonical version of a triplet by
3929 running the shell script @file{config.sub} which is included with the
3932 Some sample configuration triplets are: @samp{m68k-hp-bsd},
3933 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3935 @subheading @command{objdump} Target
3941 command line option: @option{-b} or @option{--target}
3944 environment variable @code{GNUTARGET}
3947 deduced from the input file
3950 @subheading @command{objcopy} and @command{strip} Input Target
3956 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
3959 environment variable @code{GNUTARGET}
3962 deduced from the input file
3965 @subheading @command{objcopy} and @command{strip} Output Target
3971 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
3974 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
3977 environment variable @code{GNUTARGET}
3980 deduced from the input file
3983 @subheading @command{nm}, @command{size}, and @command{strings} Target
3989 command line option: @option{--target}
3992 environment variable @code{GNUTARGET}
3995 deduced from the input file
3998 @node Architecture Selection
3999 @section Architecture Selection
4001 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4002 to run. Its name may contain a colon, separating the name of the
4003 processor family from the name of the particular @sc{cpu}.
4005 The command to list valid architecture values is @samp{objdump -i} (the
4006 second column contains the relevant information).
4008 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4010 @subheading @command{objdump} Architecture
4016 command line option: @option{-m} or @option{--architecture}
4019 deduced from the input file
4022 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4028 deduced from the input file
4031 @node Reporting Bugs
4032 @chapter Reporting Bugs
4034 @cindex reporting bugs
4036 Your bug reports play an essential role in making the binary utilities
4039 Reporting a bug may help you by bringing a solution to your problem, or
4040 it may not. But in any case the principal function of a bug report is
4041 to help the entire community by making the next version of the binary
4042 utilities work better. Bug reports are your contribution to their
4045 In order for a bug report to serve its purpose, you must include the
4046 information that enables us to fix the bug.
4049 * Bug Criteria:: Have you found a bug?
4050 * Bug Reporting:: How to report bugs
4054 @section Have You Found a Bug?
4055 @cindex bug criteria
4057 If you are not sure whether you have found a bug, here are some guidelines:
4060 @cindex fatal signal
4063 If a binary utility gets a fatal signal, for any input whatever, that is
4064 a bug. Reliable utilities never crash.
4066 @cindex error on valid input
4068 If a binary utility produces an error message for valid input, that is a
4072 If you are an experienced user of binary utilities, your suggestions for
4073 improvement are welcome in any case.
4077 @section How to Report Bugs
4079 @cindex bugs, reporting
4081 A number of companies and individuals offer support for @sc{gnu}
4082 products. If you obtained the binary utilities from a support
4083 organization, we recommend you contact that organization first.
4085 You can find contact information for many support companies and
4086 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4090 In any event, we also recommend that you send bug reports for the binary
4091 utilities to @value{BUGURL}.
4094 The fundamental principle of reporting bugs usefully is this:
4095 @strong{report all the facts}. If you are not sure whether to state a
4096 fact or leave it out, state it!
4098 Often people omit facts because they think they know what causes the
4099 problem and assume that some details do not matter. Thus, you might
4100 assume that the name of a file you use in an example does not matter.
4101 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4102 a stray memory reference which happens to fetch from the location where
4103 that pathname is stored in memory; perhaps, if the pathname were
4104 different, the contents of that location would fool the utility into
4105 doing the right thing despite the bug. Play it safe and give a
4106 specific, complete example. That is the easiest thing for you to do,
4107 and the most helpful.
4109 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4110 it is new to us. Therefore, always write your bug reports on the assumption
4111 that the bug has not been reported previously.
4113 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4114 bell?'' This cannot help us fix a bug, so it is basically useless. We
4115 respond by asking for enough details to enable us to investigate.
4116 You might as well expedite matters by sending them to begin with.
4118 To enable us to fix the bug, you should include all these things:
4122 The version of the utility. Each utility announces it if you start it
4123 with the @option{--version} argument.
4125 Without this, we will not know whether there is any point in looking for
4126 the bug in the current version of the binary utilities.
4129 Any patches you may have applied to the source, including any patches
4130 made to the @code{BFD} library.
4133 The type of machine you are using, and the operating system name and
4137 What compiler (and its version) was used to compile the utilities---e.g.
4141 The command arguments you gave the utility to observe the bug. To
4142 guarantee you will not omit something important, list them all. A copy
4143 of the Makefile (or the output from make) is sufficient.
4145 If we were to try to guess the arguments, we would probably guess wrong
4146 and then we might not encounter the bug.
4149 A complete input file, or set of input files, that will reproduce the
4150 bug. If the utility is reading an object file or files, then it is
4151 generally most helpful to send the actual object files.
4153 If the source files were produced exclusively using @sc{gnu} programs
4154 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4155 may be OK to send the source files rather than the object files. In
4156 this case, be sure to say exactly what version of @command{gcc}, or
4157 whatever, was used to produce the object files. Also say how
4158 @command{gcc}, or whatever, was configured.
4161 A description of what behavior you observe that you believe is
4162 incorrect. For example, ``It gets a fatal signal.''
4164 Of course, if the bug is that the utility gets a fatal signal, then we
4165 will certainly notice it. But if the bug is incorrect output, we might
4166 not notice unless it is glaringly wrong. You might as well not give us
4167 a chance to make a mistake.
4169 Even if the problem you experience is a fatal signal, you should still
4170 say so explicitly. Suppose something strange is going on, such as your
4171 copy of the utility is out of sync, or you have encountered a bug in
4172 the C library on your system. (This has happened!) Your copy might
4173 crash and ours would not. If you told us to expect a crash, then when
4174 ours fails to crash, we would know that the bug was not happening for
4175 us. If you had not told us to expect a crash, then we would not be able
4176 to draw any conclusion from our observations.
4179 If you wish to suggest changes to the source, send us context diffs, as
4180 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4181 option. Always send diffs from the old file to the new file. If you
4182 wish to discuss something in the @command{ld} source, refer to it by
4183 context, not by line number.
4185 The line numbers in our development sources will not match those in your
4186 sources. Your line numbers would convey no useful information to us.
4189 Here are some things that are not necessary:
4193 A description of the envelope of the bug.
4195 Often people who encounter a bug spend a lot of time investigating
4196 which changes to the input file will make the bug go away and which
4197 changes will not affect it.
4199 This is often time consuming and not very useful, because the way we
4200 will find the bug is by running a single example under the debugger
4201 with breakpoints, not by pure deduction from a series of examples.
4202 We recommend that you save your time for something else.
4204 Of course, if you can find a simpler example to report @emph{instead}
4205 of the original one, that is a convenience for us. Errors in the
4206 output will be easier to spot, running under the debugger will take
4207 less time, and so on.
4209 However, simplification is not vital; if you do not want to do this,
4210 report the bug anyway and send us the entire test case you used.
4213 A patch for the bug.
4215 A patch for the bug does help us if it is a good one. But do not omit
4216 the necessary information, such as the test case, on the assumption that
4217 a patch is all we need. We might see problems with your patch and decide
4218 to fix the problem another way, or we might not understand it at all.
4220 Sometimes with programs as complicated as the binary utilities it is
4221 very hard to construct an example that will make the program follow a
4222 certain path through the code. If you do not send us the example, we
4223 will not be able to construct one, so we will not be able to verify that
4226 And if we cannot understand what bug you are trying to fix, or why your
4227 patch should be an improvement, we will not install it. A test case will
4228 help us to understand.
4231 A guess about what the bug is or what it depends on.
4233 Such guesses are usually wrong. Even we cannot guess right about such
4234 things without first using the debugger to find the facts.
4237 @node GNU Free Documentation License
4238 @appendix GNU Free Documentation License
4242 @node Binutils Index
4243 @unnumbered Binutils Index