1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
8 * Binutils: (binutils). The GNU binary utilities "ar", "objcopy",
9 "objdump", "nm", "nlmconv", "size",
10 "strings", "strip", and "ranlib".
16 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
18 Permission is granted to make and distribute verbatim copies of
19 this manual provided the copyright notice and this permission notice
20 are preserved on all copies.
23 Permission is granted to process this file through TeX and print the
24 results, provided the printed document carries a copying permission
25 notice identical to this one except for the removal of this paragraph
26 (this paragraph not being relevant to the printed manual).
30 Permission is granted to copy and distribute modified versions of this
31 manual under the conditions for verbatim copying, provided also that
32 the entire resulting derived work is distributed under the terms of a
33 permission notice identical to this one.
35 Permission is granted to copy and distribute translations of this manual
36 into another language, under the above conditions for modified versions.
41 @c This file documents the GNU binary utilities "ar", "ld", "objcopy",
42 @c "objdump", "nm", "size", "strings", "strip", and "ranlib".
44 @c Copyright (C) 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
46 @c This text may be freely distributed under the terms of the GNU
47 @c General Public License.
50 @setchapternewpage odd
51 @settitle @sc{gnu} Binary Utilities
54 @title The @sc{gnu} Binary Utilities
55 @subtitle Version @value{VERSION}
58 @author Roland H. Pesch
59 @author Jeffrey M. Osier
60 @author Cygnus Support
64 {\parskip=0pt \hfill Cygnus Support\par \hfill
65 \TeX{}info \texinfoversion\par }
68 @vskip 0pt plus 1filll
69 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
71 Permission is granted to make and distribute verbatim copies of
72 this manual provided the copyright notice and this permission notice
73 are preserved on all copies.
75 Permission is granted to copy and distribute modified versions of this
76 manual under the conditions for verbatim copying, provided also that
77 the entire resulting derived work is distributed under the terms of a
78 permission notice identical to this one.
80 Permission is granted to copy and distribute translations of this manual
81 into another language, under the above conditions for modified versions.
88 This brief manual contains preliminary documentation for the @sc{gnu} binary
89 utilities (collectively version @value{VERSION}):
94 Create, modify, and extract from archives
97 List symbols from object files
100 Copy and translate object files
103 Display information from object files
106 Generate index to archive contents
109 List file section sizes and total size
112 List printable strings from files
118 Demangle encoded C++ symbols
121 Convert addresses into file names and line numbers
124 Convert object code into a Netware Loadable Module
127 Manipulate Windows resources
132 * ar:: Create, modify, and extract from archives
133 * nm:: List symbols from object files
134 * objcopy:: Copy and translate object files
135 * objdump:: Display information from object files
136 * ranlib:: Generate index to archive contents
137 * size:: List section sizes and total size
138 * strings:: List printable strings from files
139 * strip:: Discard symbols
140 * c++filt:: Filter to demangle encoded C++ symbols
141 * addr2line:: Convert addresses to file and line
142 * nlmconv:: Converts object code into an NLM
143 * windres:: Manipulate Windows resources
144 * Selecting The Target System:: How these utilities determine the target.
145 * Reporting Bugs:: Reporting Bugs
154 @cindex collections of files
156 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
157 ar -M [ <mri-script ]
160 The @sc{gnu} @code{ar} program creates, modifies, and extracts from
161 archives. An @dfn{archive} is a single file holding a collection of
162 other files in a structure that makes it possible to retrieve
163 the original individual files (called @dfn{members} of the archive).
165 The original files' contents, mode (permissions), timestamp, owner, and
166 group are preserved in the archive, and can be restored on
170 @sc{gnu} @code{ar} can maintain archives whose members have names of any
171 length; however, depending on how @code{ar} is configured on your
172 system, a limit on member-name length may be imposed for compatibility
173 with archive formats maintained with other tools. If it exists, the
174 limit is often 15 characters (typical of formats related to a.out) or 16
175 characters (typical of formats related to coff).
178 @code{ar} is considered a binary utility because archives of this sort
179 are most often used as @dfn{libraries} holding commonly needed
183 @code{ar} creates an index to the symbols defined in relocatable
184 object modules in the archive when you specify the modifier @samp{s}.
185 Once created, this index is updated in the archive whenever @code{ar}
186 makes a change to its contents (save for the @samp{q} update operation).
187 An archive with such an index speeds up linking to the library, and
188 allows routines in the library to call each other without regard to
189 their placement in the archive.
191 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
192 table. If an archive lacks the table, another form of @code{ar} called
193 @code{ranlib} can be used to add just the table.
195 @cindex compatibility, @code{ar}
196 @cindex @code{ar} compatibility
197 @sc{gnu} @code{ar} is designed to be compatible with two different
198 facilities. You can control its activity using command-line options,
199 like the different varieties of @code{ar} on Unix systems; or, if you
200 specify the single command-line option @samp{-M}, you can control it
201 with a script supplied via standard input, like the MRI ``librarian''
205 * ar cmdline:: Controlling @code{ar} on the command line
206 * ar scripts:: Controlling @code{ar} with a script
211 @section Controlling @code{ar} on the command line
214 ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
217 @cindex Unix compatibility, @code{ar}
218 When you use @code{ar} in the Unix style, @code{ar} insists on at least two
219 arguments to execute: one keyletter specifying the @emph{operation}
220 (optionally accompanied by other keyletters specifying
221 @emph{modifiers}), and the archive name to act on.
223 Most operations can also accept further @var{member} arguments,
224 specifying particular files to operate on.
226 @sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier
227 flags @var{mod} in any order, within the first command-line argument.
229 If you wish, you may begin the first command-line argument with a
232 @cindex operations on archive
233 The @var{p} keyletter specifies what operation to execute; it may be
234 any of the following, but you must specify only one of them:
238 @cindex deleting from archive
239 @emph{Delete} modules from the archive. Specify the names of modules to
240 be deleted as @var{member}@dots{}; the archive is untouched if you
241 specify no files to delete.
243 If you specify the @samp{v} modifier, @code{ar} lists each module
247 @cindex moving in archive
248 Use this operation to @emph{move} members in an archive.
250 The ordering of members in an archive can make a difference in how
251 programs are linked using the library, if a symbol is defined in more
254 If no modifiers are used with @code{m}, any members you name in the
255 @var{member} arguments are moved to the @emph{end} of the archive;
256 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
257 specified place instead.
260 @cindex printing from archive
261 @emph{Print} the specified members of the archive, to the standard
262 output file. If the @samp{v} modifier is specified, show the member
263 name before copying its contents to standard output.
265 If you specify no @var{member} arguments, all the files in the archive are
269 @cindex quick append to archive
270 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
271 @var{archive}, without checking for replacement.
273 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
274 operation; new members are always placed at the end of the archive.
276 The modifier @samp{v} makes @code{ar} list each file as it is appended.
278 Since the point of this operation is speed, the archive's symbol table
279 index is not updated, even if it already existed; you can use @samp{ar s} or
280 @code{ranlib} explicitly to update the symbol table index.
282 However, too many different system assume quick append rebuilds the
283 index, so GNU ar treats @code{q} to same way its treats @code{r}.
286 @cindex replacement in archive
287 Insert the files @var{member}@dots{} into @var{archive} (with
288 @emph{replacement}). This operation differs from @samp{q} in that any
289 previously existing members are deleted if their names match those being
292 If one of the files named in @var{member}@dots{} does not exist, @code{ar}
293 displays an error message, and leaves undisturbed any existing members
294 of the archive matching that name.
296 By default, new members are added at the end of the file; but you may
297 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
298 placement relative to some existing member.
300 The modifier @samp{v} used with this operation elicits a line of
301 output for each file inserted, along with one of the letters @samp{a} or
302 @samp{r} to indicate whether the file was appended (no old member
303 deleted) or replaced.
306 @cindex contents of archive
307 Display a @emph{table} listing the contents of @var{archive}, or those
308 of the files listed in @var{member}@dots{} that are present in the
309 archive. Normally only the member name is shown; if you also want to
310 see the modes (permissions), timestamp, owner, group, and size, you can
311 request that by also specifying the @samp{v} modifier.
313 If you do not specify a @var{member}, all files in the archive
316 @cindex repeated names in archive
317 @cindex name duplication in archive
318 If there is more than one file with the same name (say, @samp{fie}) in
319 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
320 first instance; to see them all, you must ask for a complete
321 listing---in our example, @samp{ar t b.a}.
322 @c WRS only; per Gumby, this is implementation-dependent, and in a more
323 @c recent case in fact works the other way.
326 @cindex extract from archive
327 @emph{Extract} members (named @var{member}) from the archive. You can
328 use the @samp{v} modifier with this operation, to request that
329 @code{ar} list each name as it extracts it.
331 If you do not specify a @var{member}, all files in the archive
336 A number of modifiers (@var{mod}) may immediately follow the @var{p}
337 keyletter, to specify variations on an operation's behavior:
341 @cindex relative placement in archive
342 Add new files @emph{after} an existing member of the
343 archive. If you use the modifier @samp{a}, the name of an existing archive
344 member must be present as the @var{relpos} argument, before the
345 @var{archive} specification.
348 Add new files @emph{before} an existing member of the
349 archive. If you use the modifier @samp{b}, the name of an existing archive
350 member must be present as the @var{relpos} argument, before the
351 @var{archive} specification. (same as @samp{i}).
354 @cindex creating archives
355 @emph{Create} the archive. The specified @var{archive} is always
356 created if it did not exist, when you request an update. But a warning is
357 issued unless you specify in advance that you expect to create it, by
361 Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file
362 names of any length. This will cause it to create archives which are
363 not compatible with the native @code{ar} program on some systems. If
364 this is a concern, the @samp{f} modifier may be used to truncate file
365 names when putting them in the archive.
368 Insert new files @emph{before} an existing member of the
369 archive. If you use the modifier @samp{i}, the name of an existing archive
370 member must be present as the @var{relpos} argument, before the
371 @var{archive} specification. (same as @samp{b}).
374 This modifier is accepted but not used.
375 @c whaffor ar l modifier??? presumably compat; with
376 @c what???---doc@@cygnus.com, 25jan91
379 @cindex dates in archive
380 Preserve the @emph{original} dates of members when extracting them. If
381 you do not specify this modifier, files extracted from the archive
382 are stamped with the time of extraction.
385 @cindex writing archive index
386 Write an object-file index into the archive, or update an existing one,
387 even if no other change is made to the archive. You may use this modifier
388 flag either with any operation, or alone. Running @samp{ar s} on an
389 archive is equivalent to running @samp{ranlib} on it.
392 @cindex updating an archive
393 Normally, @samp{ar r}@dots{} inserts all files
394 listed into the archive. If you would like to insert @emph{only} those
395 of the files you list that are newer than existing members of the same
396 names, use this modifier. The @samp{u} modifier is allowed only for the
397 operation @samp{r} (replace). In particular, the combination @samp{qu} is
398 not allowed, since checking the timestamps would lose any speed
399 advantage from the operation @samp{q}.
402 This modifier requests the @emph{verbose} version of an operation. Many
403 operations display additional information, such as filenames processed,
404 when the modifier @samp{v} is appended.
407 This modifier shows the version number of @code{ar}.
411 @section Controlling @code{ar} with a script
414 ar -M [ <@var{script} ]
417 @cindex MRI compatibility, @code{ar}
418 @cindex scripts, @code{ar}
419 If you use the single command-line option @samp{-M} with @code{ar}, you
420 can control its operation with a rudimentary command language. This
421 form of @code{ar} operates interactively if standard input is coming
422 directly from a terminal. During interactive use, @code{ar} prompts for
423 input (the prompt is @samp{AR >}), and continues executing even after
424 errors. If you redirect standard input to a script file, no prompts are
425 issued, and @code{ar} abandons execution (with a nonzero exit code)
428 The @code{ar} command language is @emph{not} designed to be equivalent
429 to the command-line options; in fact, it provides somewhat less control
430 over archives. The only purpose of the command language is to ease the
431 transition to @sc{gnu} @code{ar} for developers who already have scripts
432 written for the MRI ``librarian'' program.
434 The syntax for the @code{ar} command language is straightforward:
437 commands are recognized in upper or lower case; for example, @code{LIST}
438 is the same as @code{list}. In the following descriptions, commands are
439 shown in upper case for clarity.
442 a single command may appear on each line; it is the first word on the
446 empty lines are allowed, and have no effect.
449 comments are allowed; text after either of the characters @samp{*}
450 or @samp{;} is ignored.
453 Whenever you use a list of names as part of the argument to an @code{ar}
454 command, you can separate the individual names with either commas or
455 blanks. Commas are shown in the explanations below, for clarity.
458 @samp{+} is used as a line continuation character; if @samp{+} appears
459 at the end of a line, the text on the following line is considered part
460 of the current command.
463 Here are the commands you can use in @code{ar} scripts, or when using
464 @code{ar} interactively. Three of them have special significance:
466 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
467 a temporary file required for most of the other commands.
469 @code{SAVE} commits the changes so far specified by the script. Prior
470 to @code{SAVE}, commands affect only the temporary copy of the current
474 @item ADDLIB @var{archive}
475 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
476 Add all the contents of @var{archive} (or, if specified, each named
477 @var{module} from @var{archive}) to the current archive.
479 Requires prior use of @code{OPEN} or @code{CREATE}.
481 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
482 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
483 @c else like "ar q..."
484 Add each named @var{member} as a module in the current archive.
486 Requires prior use of @code{OPEN} or @code{CREATE}.
489 Discard the contents of the current archive, cancelling the effect of
490 any operations since the last @code{SAVE}. May be executed (with no
491 effect) even if no current archive is specified.
493 @item CREATE @var{archive}
494 Creates an archive, and makes it the current archive (required for many
495 other commands). The new archive is created with a temporary name; it
496 is not actually saved as @var{archive} until you use @code{SAVE}.
497 You can overwrite existing archives; similarly, the contents of any
498 existing file named @var{archive} will not be destroyed until @code{SAVE}.
500 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
501 Delete each listed @var{module} from the current archive; equivalent to
502 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
504 Requires prior use of @code{OPEN} or @code{CREATE}.
506 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
507 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
508 List each named @var{module} present in @var{archive}. The separate
509 command @code{VERBOSE} specifies the form of the output: when verbose
510 output is off, output is like that of @samp{ar -t @var{archive}
511 @var{module}@dots{}}. When verbose output is on, the listing is like
512 @samp{ar -tv @var{archive} @var{module}@dots{}}.
514 Output normally goes to the standard output stream; however, if you
515 specify @var{outputfile} as a final argument, @code{ar} directs the
519 Exit from @code{ar}, with a @code{0} exit code to indicate successful
520 completion. This command does not save the output file; if you have
521 changed the current archive since the last @code{SAVE} command, those
524 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
525 Extract each named @var{module} from the current archive, writing them
526 into the current directory as separate files. Equivalent to @samp{ar -x
527 @var{archive} @var{module}@dots{}}.
529 Requires prior use of @code{OPEN} or @code{CREATE}.
532 @c FIXME Tokens but no commands???
539 Display full contents of the current archive, in ``verbose'' style
540 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
541 tv @var{archive}}). (This single command is a @sc{gnu} @code{ld}
542 enhancement, rather than present for MRI compatibility.)
544 Requires prior use of @code{OPEN} or @code{CREATE}.
546 @item OPEN @var{archive}
547 Opens an existing archive for use as the current archive (required for
548 many other commands). Any changes as the result of subsequent commands
549 will not actually affect @var{archive} until you next use @code{SAVE}.
551 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
552 In the current archive, replace each existing @var{module} (named in
553 the @code{REPLACE} arguments) from files in the current working directory.
554 To execute this command without errors, both the file, and the module in
555 the current archive, must exist.
557 Requires prior use of @code{OPEN} or @code{CREATE}.
560 Toggle an internal flag governing the output from @code{DIRECTORY}.
561 When the flag is on, @code{DIRECTORY} output matches output from
562 @samp{ar -tv }@dots{}.
565 Commit your changes to the current archive, and actually save it as a
566 file with the name specified in the last @code{CREATE} or @code{OPEN}
569 Requires prior use of @code{OPEN} or @code{CREATE}.
578 The @sc{gnu} linker @code{ld} is now described in a separate manual.
579 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
588 nm [ -a | --debug-syms ] [ -g | --extern-only ]
589 [ -B ] [ -C | --demangle ] [ -D | --dynamic ]
590 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
591 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
592 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
593 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
594 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
595 [ --defined-only ] [-l | --line-numbers ]
596 [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
599 @sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}.
600 If no object files are listed as arguments, @code{nm} assumes
603 For each symbol, @code{nm} shows:
607 The symbol value, in the radix selected by options (see below), or
608 hexadecimal by default.
611 The symbol type. At least the following types are used; others are, as
612 well, depending on the object file format. If lowercase, the symbol is
613 local; if uppercase, the symbol is global (external).
615 @c Some more detail on exactly what these symbol types are used for
619 The symbol's value is absolute, and will not be changed by further
623 The symbol is in the uninitialized data section (known as BSS).
626 The symbol is common. Common symbols are uninitialized data. When
627 linking, multiple common symbols may appear with the same name. If the
628 symbol is defined anywhere, the common symbols are treated as undefined
629 references. For more details on common symbols, see the discussion of
630 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
633 The symbol is in the initialized data section.
636 The symbol is in an initialized data section for small objects. Some
637 object file formats permit more efficient access to small data objects,
638 such as a global int variable as opposed to a large global array.
641 The symbol is an indirect reference to another symbol. This is a GNU
642 extension to the a.out object file format which is rarely used.
645 The symbol is a debugging symbol.
648 The symbol is in a read only data section.
651 The symbol is in an uninitialized data section for small objects.
654 The symbol is in the text (code) section.
657 The symbol is undefined.
660 The symbol is weak. When a weak defined symbol is linked with a normal
661 defined symbol, the normal defined symbol is used with no error. When a
662 weak undefined symbol is linked and the symbol is not defined, the value
663 of the weak symbol becomes zero with no error.
666 The symbol is a stabs symbol in an a.out object file. In this case, the
667 next values printed are the stabs other field, the stabs desc field, and
668 the stab type. Stabs symbols are used to hold debugging information;
669 for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
670 ``stabs'' debug format}.
673 The symbol type is unknown, or object file format specific.
680 The long and short forms of options, shown here as alternatives, are
686 @itemx --print-file-name
687 @cindex input file name
689 @cindex source file name
690 Precede each symbol by the name of the input file (or archive element)
691 in which it was found, rather than identifying the input file once only,
692 before all of its symbols.
696 @cindex debugging symbols
697 Display all symbols, even debugger-only symbols; normally these are not
701 @cindex @code{nm} format
702 @cindex @code{nm} compatibility
703 The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
707 @cindex demangling in nm
708 Decode (@dfn{demangle}) low-level symbol names into user-level names.
709 Besides removing any initial underscore prepended by the system, this
710 makes C++ function names readable. @xref{c++filt}, for more information
714 Do not demangle low-level symbol names. This is the default.
718 @cindex dynamic symbols
719 Display the dynamic symbols rather than the normal symbols. This is
720 only meaningful for dynamic objects, such as certain types of shared
723 @item -f @var{format}
724 @itemx --format=@var{format}
725 @cindex @code{nm} format
726 @cindex @code{nm} compatibility
727 Use the output format @var{format}, which can be @code{bsd},
728 @code{sysv}, or @code{posix}. The default is @code{bsd}.
729 Only the first character of @var{format} is significant; it can be
730 either upper or lower case.
734 @cindex external symbols
735 Display only external symbols.
738 @itemx --line-numbers
739 @cindex symbol line numbers
740 For each symbol, use debugging information to try to find a filename and
741 line number. For a defined symbol, look for the line number of the
742 address of the symbol. For an undefined symbol, look for the line
743 number of a relocation entry which refers to the symbol. If line number
744 information can be found, print it after the other symbol information.
748 @itemx --numeric-sort
749 Sort symbols numerically by their addresses, rather than alphabetically
754 @cindex sorting symbols
755 Do not bother to sort the symbols in any order; print them in the order
760 Use the POSIX.2 standard output format instead of the default format.
761 Equivalent to @samp{-f posix}.
765 @cindex symbol index, listing
766 When listing symbols from archive members, include the index: a mapping
767 (stored in the archive by @code{ar} or @code{ranlib}) of which modules
768 contain definitions for which names.
771 @itemx --reverse-sort
772 Reverse the order of the sort (whether numeric or alphabetic); let the
776 Sort symbols by size. The size is computed as the difference between
777 the value of the symbol and the value of the symbol with the next higher
778 value. The size of the symbol is printed, rather than the value.
781 @itemx --radix=@var{radix}
782 Use @var{radix} as the radix for printing the symbol values. It must be
783 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
785 @item --target=@var{bfdname}
786 @cindex object code format
787 Specify an object code format other than your system's default format.
788 @xref{Target Selection}, for more information.
791 @itemx --undefined-only
792 @cindex external symbols
793 @cindex undefined symbols
794 Display only undefined symbols (those external to each object file).
797 @cindex external symbols
798 @cindex undefined symbols
799 Display only defined symbols for each object file.
803 Show the version number of @code{nm} and exit.
806 Show a summary of the options to @code{nm} and exit.
813 objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
814 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
815 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
816 [ -S | --strip-all ] [ -g | --strip-debug ]
817 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
818 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
819 [ -P @var{symbolname} | --privatize-symbol=@var{symbolname} ]
820 [ -W @var{symbolname} | --weaken-symbol=@var{symbolname} ]
821 [ -x | --discard-all ] [ -X | --discard-locals ]
822 [ -b @var{byte} | --byte=@var{byte} ]
823 [ -i @var{interleave} | --interleave=@var{interleave} ]
824 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
825 [ -p | --preserve-dates ] [ --debugging ]
826 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
827 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
828 [ --adjust-vma=@var{incr} ]
829 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
830 [ --adjust-warnings ] [ --no-adjust-warnings ]
831 [ --set-section-flags=@var{section}=@var{flags} ]
832 [ --add-section=@var{sectionname}=@var{filename} ]
833 [ --change-leading-char ] [ --remove-leading-char ]
835 [ -v | --verbose ] [ -V | --version ] [ --help ]
836 @var{infile} [@var{outfile}]
839 The @sc{gnu} @code{objcopy} utility copies the contents of an object
840 file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
841 read and write the object files. It can write the destination object
842 file in a format different from that of the source object file. The
843 exact behavior of @code{objcopy} is controlled by command-line options.
845 @code{objcopy} creates temporary files to do its translations and
846 deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
847 translation work; it has access to all the formats described in @sc{bfd}
848 and thus is able to recognize most formats without being told
849 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
851 @code{objcopy} can be used to generate S-records by using an output
852 target of @samp{srec} (e.g., use @samp{-O srec}).
854 @code{objcopy} can be used to generate a raw binary file by using an
855 output target of @samp{binary} (e.g., use @samp{-O binary}). When
856 @code{objcopy} generates a raw binary file, it will essentially produce
857 a memory dump of the contents of the input object file. All symbols and
858 relocation information will be discarded. The memory dump will start at
859 the load address of the lowest section copied into the output file.
861 When generating an S-record or a raw binary file, it may be helpful to
862 use @samp{-S} to remove sections containing debugging information. In
863 some cases @samp{-R} will be useful to remove sections which contain
864 information which is not needed by the binary file.
869 The source and output files, respectively.
870 If you do not specify @var{outfile}, @code{objcopy} creates a
871 temporary file and destructively renames the result with
872 the name of @var{infile}.
874 @item -I @var{bfdname}
875 @itemx --input-target=@var{bfdname}
876 Consider the source file's object format to be @var{bfdname}, rather than
877 attempting to deduce it. @xref{Target Selection}, for more information.
879 @item -O @var{bfdname}
880 @itemx --output-target=@var{bfdname}
881 Write the output file using the object format @var{bfdname}.
882 @xref{Target Selection}, for more information.
884 @item -F @var{bfdname}
885 @itemx --target=@var{bfdname}
886 Use @var{bfdname} as the object format for both the input and the output
887 file; i.e., simply transfer data from source to destination with no
888 translation. @xref{Target Selection}, for more information.
890 @item -R @var{sectionname}
891 @itemx --remove-section=@var{sectionname}
892 Remove any section named @var{sectionname} from the output file. This
893 option may be given more than once. Note that using this option
894 inappropriately may make the output file unusable.
898 Do not copy relocation and symbol information from the source file.
902 Do not copy debugging symbols from the source file.
904 @item --strip-unneeded
905 Strip all symbols that are not needed for relocation processing.
907 @item -K @var{symbolname}
908 @itemx --keep-symbol=@var{symbolname}
909 Copy only symbol @var{symbolname} from the source file. This option may
910 be given more than once.
912 @item -N @var{symbolname}
913 @itemx --strip-symbol=@var{symbolname}
914 Do not copy symbol @var{symbolname} from the source file. This option
915 may be given more than once.
917 @item -P @var{symbolname}
918 @itemx --privatize-symbol=@var{symbolname}
919 Make symbol @var{symbolname} local to the file, so that it is not
920 visible externally. This option may be given more than once.
922 @item -W @var{symbolname}
923 @itemx --weaken-symbol=@var{symbolname}
924 Make symbol @var{symbolname} weak. This option may be given more than once.
928 Do not copy non-global symbols from the source file.
929 @c FIXME any reason to prefer "non-global" to "local" here?
932 @itemx --discard-locals
933 Do not copy compiler-generated local symbols.
934 (These usually start with @samp{L} or @samp{.}.)
937 @itemx --byte=@var{byte}
938 Keep only every @var{byte}th byte of the input file (header data is not
939 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
940 where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
941 option, or the default of 4. This option is useful for creating files
942 to program @sc{rom}. It is typically used with an @code{srec} output
945 @item -i @var{interleave}
946 @itemx --interleave=@var{interleave}
947 Only copy one out of every @var{interleave} bytes. Select which byte to
948 copy with the @var{-b} or @samp{--byte} option. The default is 4.
949 @code{objcopy} ignores this option if you do not specify either @samp{-b} or
953 @itemx --preserve-dates
954 Set the access and modification dates of the output file to be the same
955 as those of the input file.
958 Convert debugging information, if possible. This is not the default
959 because only certain debugging formats are supported, and the
960 conversion process can be time consuming.
962 @item --gap-fill @var{val}
963 Fill gaps between sections with @var{val}. This is done by increasing
964 the size of the section with the lower address, and filling in the extra
965 space created with @var{val}.
967 @item --pad-to @var{address}
968 Pad the output file up to the virtual address @var{address}. This is
969 done by increasing the size of the last section. The extra space is
970 filled in with the value specified by @samp{--gap-fill} (default zero).
972 @item --set-start @var{val}
973 Set the address of the new file to @var{val}. Not all object file
974 formats support setting the start address.
976 @item --adjust-start @var{incr}
977 Adjust the start address by adding @var{incr}. Not all object file
978 formats support setting the start address.
980 @item --adjust-vma @var{incr}
981 Adjust the address of all sections, as well as the start address, by
982 adding @var{incr}. Some object file formats do not permit section
983 addresses to be changed arbitrarily. Note that this does not relocate
984 the sections; if the program expects sections to be loaded at a certain
985 address, and this option is used to change the sections such that they
986 are loaded at a different address, the program may fail.
988 @item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
989 Set or adjust the address of the named @var{section}. If @samp{=} is
990 used, the section address is set to @var{val}. Otherwise, @var{val} is
991 added to or subtracted from the section address. See the comments under
992 @samp{--adjust-vma}, above. If @var{section} does not exist in the
993 input file, a warning will be issued, unless @samp{--no-adjust-warnings}
996 @item --adjust-warnings
997 If @samp{--adjust-section-vma} is used, and the named section does not
998 exist, issue a warning. This is the default.
1000 @item --no-adjust-warnings
1001 Do not issue a warning if @samp{--adjust-section-vma} is used, even if
1002 the named section does not exist.
1004 @item --set-section-flags @var{section}=@var{flags}
1005 Set the flags for the named section. The @var{flags} argument is a
1006 comma separated string of flag names. The recognized names are
1007 @samp{alloc}, @samp{load}, @samp{readonly}, @samp{code}, @samp{data},
1008 and @samp{rom}. Not all flags are meaningful for all object file
1011 @item --add-section @var{sectionname}=@var{filename}
1012 Add a new section named @var{sectionname} while copying the file. The
1013 contents of the new section are taken from the file @var{filename}. The
1014 size of the section will be the size of the file. This option only
1015 works on file formats which can support sections with arbitrary names.
1017 @item --change-leading-char
1018 Some object file formats use special characters at the start of
1019 symbols. The most common such character is underscore, which compilers
1020 often add before every symbol. This option tells @code{objcopy} to
1021 change the leading character of every symbol when it converts between
1022 object file formats. If the object file formats use the same leading
1023 character, this option has no effect. Otherwise, it will add a
1024 character, or remove a character, or change a character, as
1027 @item --remove-leading-char
1028 If the first character of a global symbol is a special symbol leading
1029 character used by the object file format, remove the character. The
1030 most common symbol leading character is underscore. This option will
1031 remove a leading underscore from all global symbols. This can be useful
1032 if you want to link together objects of different file formats with
1033 different conventions for symbol names. This is different from
1034 @code{--change-leading-char} because it always changes the symbol name
1035 when appropriate, regardless of the object file format of the output
1039 Change all global symbols in the file to be weak. This can be useful
1040 when building an object which will be linked against other objects using
1041 the @code{-R} option to the linker. This option is only effective when
1042 using an object file format which supports weak symbols.
1046 Show the version number of @code{objcopy}.
1050 Verbose output: list all object files modified. In the case of
1051 archives, @samp{objcopy -V} lists all members of the archive.
1054 Show a summary of the options to @code{objcopy}.
1060 @cindex object file information
1064 objdump [ -a | --archive-headers ]
1065 [ -b @var{bfdname} | --target=@var{bfdname} ] [ --debugging ]
1066 [ -C | --demangle ] [ -d | --disassemble ]
1067 [ -D | --disassemble-all ] [ --disassemble-zeroes ]
1068 [ -EB | -EL | --endian=@{big | little @} ]
1069 [ -f | --file-headers ]
1070 [ -h | --section-headers | --headers ] [ -i | --info ]
1071 [ -j @var{section} | --section=@var{section} ]
1072 [ -l | --line-numbers ] [ -S | --source ]
1073 [ -m @var{machine} | --architecture=@var{machine} ]
1074 [ -r | --reloc ] [ -R | --dynamic-reloc ]
1075 [ -s | --full-contents ] [ --stabs ]
1076 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
1077 [ -w | --wide ] [ --start-address=@var{address} ]
1078 [ --stop-address=@var{address} ]
1079 [ --prefix-addresses] [ --[no-]show-raw-insn ]
1080 [ --adjust-vma=@var{offset} ]
1081 [ --version ] [ --help ]
1082 @var{objfile}@dots{}
1085 @code{objdump} displays information about one or more object files.
1086 The options control what particular information to display. This
1087 information is mostly useful to programmers who are working on the
1088 compilation tools, as opposed to programmers who just want their
1089 program to compile and work.
1091 @var{objfile}@dots{} are the object files to be examined. When you
1092 specify archives, @code{objdump} shows information on each of the member
1095 The long and short forms of options, shown here as alternatives, are
1096 equivalent. At least one option besides @samp{-l} must be given.
1100 @itemx --archive-header
1101 @cindex archive headers
1102 If any of the @var{objfile} files are archives, display the archive
1103 header information (in a format similar to @samp{ls -l}). Besides the
1104 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1105 the object file format of each archive member.
1107 @item --adjust-vma=@var{offset}
1108 @cindex section addresses in objdump
1109 @cindex VMA in objdump
1110 When dumping information, first add @var{offset} to all the section
1111 addresses. This is useful if the section addresses do not correspond to
1112 the symbol table, which can happen when putting sections at particular
1113 addresses when using a format which can not represent section addresses,
1116 @item -b @var{bfdname}
1117 @itemx --target=@var{bfdname}
1118 @cindex object code format
1119 Specify that the object-code format for the object files is
1120 @var{bfdname}. This option may not be necessary; @var{objdump} can
1121 automatically recognize many formats.
1125 objdump -b oasys -m vax -h fu.o
1128 displays summary information from the section headers (@samp{-h}) of
1129 @file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
1130 file in the format produced by Oasys compilers. You can list the
1131 formats available with the @samp{-i} option.
1132 @xref{Target Selection}, for more information.
1136 @cindex demangling in objdump
1137 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1138 Besides removing any initial underscore prepended by the system, this
1139 makes C++ function names readable. @xref{c++filt}, for more information
1143 Display debugging information. This attempts to parse debugging
1144 information stored in the file and print it out using a C like syntax.
1145 Only certain types of debugging information have been implemented.
1148 @itemx --disassemble
1149 @cindex disassembling object code
1150 @cindex machine instructions
1151 Display the assembler mnemonics for the machine instructions from
1152 @var{objfile}. This option only disassembles those sections which are
1153 expected to contain instructions.
1156 @itemx --disassemble-all
1157 Like @samp{-d}, but disassemble the contents of all sections, not just
1158 those expected to contain instructions.
1160 @item --prefix-addresses
1161 When disassembling, print the complete address on each line. This is
1162 the older disassembly format.
1164 @item --disassemble-zeroes
1165 Normally the disassembly output will skip blocks of zeroes. This
1166 option directs the disassembler to disassemble those blocks, just like
1171 @itemx --endian=@{big|little@}
1173 @cindex disassembly endianness
1174 Specify the endianness of the object files. This only affects
1175 disassembly. This can be useful when disassembling a file format which
1176 does not describe endianness information, such as S-records.
1179 @itemx --file-header
1180 @cindex object file header
1181 Display summary information from the overall header of
1182 each of the @var{objfile} files.
1185 @itemx --section-header
1187 @cindex section headers
1188 Display summary information from the section headers of the
1191 File segments may be relocated to nonstandard addresses, for example by
1192 using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1193 @code{ld}. However, some object file formats, such as a.out, do not
1194 store the starting address of the file segments. In those situations,
1195 although @code{ld} relocates the sections correctly, using @samp{objdump
1196 -h} to list the file section headers cannot show the correct addresses.
1197 Instead, it shows the usual addresses, which are implicit for the
1201 Print a summary of the options to @code{objdump} and exit.
1205 @cindex architectures available
1206 @cindex object formats available
1207 Display a list showing all architectures and object formats available
1208 for specification with @samp{-b} or @samp{-m}.
1211 @itemx --section=@var{name}
1212 @cindex section information
1213 Display information only for section @var{name}.
1216 @itemx --line-numbers
1217 @cindex source filenames for object files
1218 Label the display (using debugging information) with the filename and
1219 source line numbers corresponding to the object code or relocs shown.
1220 Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
1222 @item -m @var{machine}
1223 @itemx --architecture=@var{machine}
1224 @cindex architecture
1225 @cindex disassembly architecture
1226 Specify the architecture to use when disassembling object files. This
1227 can be useful when disasembling object files which do not describe
1228 architecture information, such as S-records. You can list the available
1229 architectures with the @samp{-i} option.
1233 @cindex relocation entries, in object file
1234 Print the relocation entries of the file. If used with @samp{-d} or
1235 @samp{-D}, the relocations are printed interspersed with the
1239 @itemx --dynamic-reloc
1240 @cindex dynamic relocation entries, in object file
1241 Print the dynamic relocation entries of the file. This is only
1242 meaningful for dynamic objects, such as certain types of shared
1246 @itemx --full-contents
1247 @cindex sections, full contents
1248 @cindex object file sections
1249 Display the full contents of any sections requested.
1253 @cindex source disassembly
1254 @cindex disassembly, with source
1255 Display source code intermixed with disassembly, if possible. Implies
1258 @item --show-raw-insn
1259 When disassembling instructions, print the instruction in hex as well as
1260 in symbolic form. This is the default except when
1261 @code{--prefix-addresses} is used.
1263 @item --no-show-raw-insn
1264 When disassembling instructions, do not print the instruction bytes.
1265 This is the default when @code{--prefix-addresses} is used.
1270 @cindex debug symbols
1271 @cindex ELF object file format
1272 Display the full contents of any sections requested. Display the
1273 contents of the .stab and .stab.index and .stab.excl sections from an
1274 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1275 @code{.stab} debugging symbol-table entries are carried in an ELF
1276 section. In most other file formats, debugging symbol-table entries are
1277 interleaved with linkage symbols, and are visible in the @samp{--syms}
1278 output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1279 Overview,stabs.info, The ``stabs'' debug format}.
1281 @item --start-address=@var{address}
1282 @cindex start-address
1283 Start displaying data at the specified address. This affects the output
1284 of the @code{-d}, @code{-r} and @code{-s} options.
1286 @item --stop-address=@var{address}
1287 @cindex stop-address
1288 Stop displaying data at the specified address. This affects the output
1289 of the @code{-d}, @code{-r} and @code{-s} options.
1293 @cindex symbol table entries, printing
1294 Print the symbol table entries of the file.
1295 This is similar to the information provided by the @samp{nm} program.
1298 @itemx --dynamic-syms
1299 @cindex dynamic symbol table entries, printing
1300 Print the dynamic symbol table entries of the file. This is only
1301 meaningful for dynamic objects, such as certain types of shared
1302 libraries. This is similar to the information provided by the @samp{nm}
1303 program when given the @samp{-D} (@samp{--dynamic}) option.
1306 Print the version number of @code{objdump} and exit.
1310 @cindex all header information, object file
1311 @cindex header information, all
1312 Display all available header information, including the symbol table and
1313 relocation entries. Using @samp{-x} is equivalent to specifying all of
1314 @samp{-a -f -h -r -t}.
1318 @cindex wide output, printing
1319 Format some lines for output devices that have more than 80 columns.
1326 @cindex archive contents
1327 @cindex symbol index
1330 ranlib [-vV] @var{archive}
1333 @code{ranlib} generates an index to the contents of an archive and
1334 stores it in the archive. The index lists each symbol defined by a
1335 member of an archive that is a relocatable object file.
1337 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1339 An archive with such an index speeds up linking to the library and
1340 allows routines in the library to call each other without regard to
1341 their placement in the archive.
1343 The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
1344 @code{ranlib} is completely equivalent to executing @samp{ar -s}.
1350 Show the version number of @code{ranlib}.
1357 @cindex section sizes
1360 size [ -A | -B | --format=@var{compatibility} ]
1361 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1362 [ --target=@var{bfdname} ] [ -V | --version ]
1363 [ @var{objfile}@dots{} ]
1366 The @sc{gnu} @code{size} utility lists the section sizes---and the total
1367 size---for each of the object or archive files @var{objfile} in its
1368 argument list. By default, one line of output is generated for each
1369 object file or each module in an archive.
1371 @var{objfile}@dots{} are the object files to be examined.
1372 If none are specified, the file @code{a.out} will be used.
1374 The command line options have the following meanings:
1379 @itemx --format=@var{compatibility}
1380 @cindex @code{size} display format
1381 Using one of these options, you can choose whether the output from @sc{gnu}
1382 @code{size} resembles output from System V @code{size} (using @samp{-A},
1383 or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1384 @samp{--format=berkeley}). The default is the one-line format similar to
1386 @c Bonus for doc-source readers: you can also say --format=strange (or
1387 @c anything else that starts with 's') for sysv, and --format=boring (or
1388 @c anything else that starts with 'b') for Berkeley.
1390 Here is an example of the Berkeley (default) format of output from
1393 size --format=Berkeley ranlib size
1394 text data bss dec hex filename
1395 294880 81920 11592 388392 5ed28 ranlib
1396 294880 81920 11888 388688 5ee50 size
1400 This is the same data, but displayed closer to System V conventions:
1403 size --format=SysV ranlib size
1421 Show a summary of acceptable arguments and options.
1426 @itemx --radix=@var{number}
1427 @cindex @code{size} number format
1428 @cindex radix for section sizes
1429 Using one of these options, you can control whether the size of each
1430 section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1431 (@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1432 @samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
1433 values (8, 10, 16) are supported. The total size is always given in two
1434 radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1435 octal and hexadecimal if you're using @samp{-o}.
1437 @item --target=@var{bfdname}
1438 @cindex object code format
1439 Specify that the object-code format for @var{objfile} is
1440 @var{bfdname}. This option may not be necessary; @code{size} can
1441 automatically recognize many formats.
1442 @xref{Target Selection}, for more information.
1446 Display the version number of @code{size}.
1452 @cindex listings strings
1453 @cindex printing strings
1454 @cindex strings, printing
1457 strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
1458 [--all] [--print-file-name] [--bytes=@var{min-len}]
1459 [--radix=@var{radix}] [--target=@var{bfdname}]
1460 [--help] [--version] @var{file}@dots{}
1463 For each @var{file} given, @sc{gnu} @code{strings} prints the printable
1464 character sequences that are at least 4 characters long (or the number
1465 given with the options below) and are followed by an unprintable
1466 character. By default, it only prints the strings from the initialized
1467 and loaded sections of object files; for other types of files, it prints
1468 the strings from the whole file.
1470 @code{strings} is mainly useful for determining the contents of non-text
1477 Do not scan only the initialized and loaded sections of object files;
1478 scan the whole files.
1481 @itemx --print-file-name
1482 Print the name of the file before each string.
1485 Print a summary of the program usage on the standard output and exit.
1487 @itemx -@var{min-len}
1488 @item -n @var{min-len}
1489 @itemx --bytes=@var{min-len}
1490 Print sequences of characters that are at least @var{min-len} characters
1491 long, instead of the default 4.
1494 Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1495 act like @samp{-t d} instead. Since we can not be compatible with both
1496 ways, we simply chose one.
1498 @item -t @var{radix}
1499 @itemx --radix=@var{radix}
1500 Print the offset within the file before each string. The single
1501 character argument specifies the radix of the offset---@samp{o} for
1502 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1504 @item --target=@var{bfdname}
1505 @cindex object code format
1506 Specify an object code format other than your system's default format.
1507 @xref{Target Selection}, for more information.
1511 Print the program version number on the standard output and exit.
1518 @cindex removing symbols
1519 @cindex discarding symbols
1520 @cindex symbols, discarding
1523 strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ]
1524 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1525 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1526 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1527 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
1528 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
1529 [ -x | --discard-all ] [ -X | --discard-locals ]
1530 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
1531 [ -o @var{file} ] [ -p | --preserve-dates ]
1532 [ -v | --verbose ] [ -V | --version ] [ --help ]
1533 @var{objfile}@dots{}
1536 @sc{gnu} @code{strip} discards all symbols from object files
1537 @var{objfile}. The list of object files may include archives.
1538 At least one object file must be given.
1540 @code{strip} modifies the files named in its argument,
1541 rather than writing modified copies under different names.
1544 @item -F @var{bfdname}
1545 @itemx --target=@var{bfdname}
1546 Treat the original @var{objfile} as a file with the object
1547 code format @var{bfdname}, and rewrite it in the same format.
1548 @xref{Target Selection}, for more information.
1551 Show a summary of the options to @code{strip} and exit.
1553 @item -I @var{bfdname}
1554 @itemx --input-target=@var{bfdname}
1555 Treat the original @var{objfile} as a file with the object
1556 code format @var{bfdname}.
1557 @xref{Target Selection}, for more information.
1559 @item -O @var{bfdname}
1560 @itemx --output-target=@var{bfdname}
1561 Replace @var{objfile} with a file in the output format @var{bfdname}.
1562 @xref{Target Selection}, for more information.
1564 @item -R @var{sectionname}
1565 @itemx --remove-section=@var{sectionname}
1566 Remove any section named @var{sectionname} from the output file. This
1567 option may be given more than once. Note that using this option
1568 inappropriately may make the output file unusable.
1576 @itemx --strip-debug
1577 Remove debugging symbols only.
1579 @item --strip-unneeded
1580 Remove all symbols that are not needed for relocation processing.
1582 @item -K @var{symbolname}
1583 @itemx --keep-symbol=@var{symbolname}
1584 Keep only symbol @var{symbolname} from the source file. This option may
1585 be given more than once.
1587 @item -N @var{symbolname}
1588 @itemx --strip-symbol=@var{symbolname}
1589 Remove symbol @var{symbolname} from the source file. This option may be
1590 given more than once, and may be combined with strip options other than
1594 Put the stripped output in @var{file}, rather than replacing the
1595 existing file. When this argument is used, only one @var{objfile}
1596 argument may be specified.
1599 @itemx --preserve-dates
1600 Preserve the access and modification dates of the file.
1603 @itemx --discard-all
1604 Remove non-global symbols.
1607 @itemx --discard-locals
1608 Remove compiler-generated local symbols.
1609 (These usually start with @samp{L} or @samp{.}.)
1613 Show the version number for @code{strip}.
1617 Verbose output: list all object files modified. In the case of
1618 archives, @samp{strip -v} lists all members of the archive.
1625 @cindex demangling C++ symbols
1628 c++filt [ -_ | --strip-underscores ]
1629 [ -n | --no-strip-underscores ]
1630 [ -s @var{format} | --format=@var{format} ]
1631 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
1634 The C++ language provides function overloading, which means that you can
1635 write many functions with the same name (providing each takes parameters
1636 of different types). All C++ function names are encoded into a
1637 low-level assembly label (this process is known as
1638 @dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1639 decodes (@dfn{demangles}) low-level names into user-level names so that
1640 the linker can keep these overloaded functions from clashing.
1642 Every alphanumeric word (consisting of letters, digits, underscores,
1643 dollars, or periods) seen in the input is a potential label. If the
1644 label decodes into a C++ name, the C++ name replaces the low-level
1647 You can use @code{c++filt} to decipher individual symbols:
1650 c++filt @var{symbol}
1653 If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1654 names from the standard input and writes the demangled names to the
1655 standard output. All results are printed on the standard output.
1659 @itemx --strip-underscores
1660 On some systems, both the C and C++ compilers put an underscore in front
1661 of every name. For example, the C name @code{foo} gets the low-level
1662 name @code{_foo}. This option removes the initial underscore. Whether
1663 @code{c++filt} removes the underscore by default is target dependent.
1666 @itemx --no-strip-underscores
1667 Do not remove the initial underscore.
1669 @item -s @var{format}
1670 @itemx --format=@var{format}
1671 @sc{gnu} @code{nm} can decode three different methods of mangling, used by
1672 different C++ compilers. The argument to this option selects which
1677 the one used by the @sc{gnu} compiler (the default method)
1679 the one used by the Lucid compiler
1681 the one specified by the C++ Annotated Reference Manual
1685 Print a summary of the options to @code{c++filt} and exit.
1688 Print the version number of @code{c++filt} and exit.
1692 @emph{Warning:} @code{c++filt} is a new utility, and the details of its
1693 user interface are subject to change in future releases. In particular,
1694 a command-line option may be required in the the future to decode a name
1695 passed as an argument on the command line; in other words,
1698 c++filt @var{symbol}
1702 may in a future release become
1705 c++filt @var{option} @var{symbol}
1713 @cindex address to file name and line number
1716 addr2line [ -b @var{bfdname} | --target=@var{bfdname} ]
1718 [ -e @var{filename} | --exe=@var{filename} ]
1719 [ -f | --functions ] [ -s | --basename ]
1720 [ -H | --help ] [ -V | --version ]
1724 @code{addr2line} translates program addresses into file names and line
1725 numbers. Given an address and an executable, it uses the debugging
1726 information in the executable to figure out which file name and line
1727 number are associated with a given address.
1729 The executable to use is specified with the @code{-e} option. The
1730 default is @file{a.out}.
1732 @code{addr2line} has two modes of operation.
1734 In the first, hexadecimal addresses are specified on the command line,
1735 and @code{addr2line} displays the file name and line number for each
1738 In the second, @code{addr2line} reads hexadecimal addresses from
1739 standard input, and prints the file name and line number for each
1740 address on standard output. In this mode, @code{addr2line} may be used
1741 in a pipe to convert dynamically chosen addresses.
1743 The format of the output is @samp{FILENAME:LINENO}. The file name and
1744 line number for each address is printed on a separate line. If the
1745 @code{-f} option is used, then each @samp{FILENAME:LINENO} line is
1746 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
1747 containing the address.
1749 If the file name or function name can not be determined,
1750 @code{addr2line} will print two question marks in their place. If the
1751 line number can not be determined, @code{addr2line} will print 0.
1753 The long and short forms of options, shown here as alternatives, are
1757 @item -b @var{bfdname}
1758 @itemx --target=@var{bfdname}
1759 @cindex object code format
1760 Specify that the object-code format for the object files is
1765 @cindex demangling in objdump
1766 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1767 Besides removing any initial underscore prepended by the system, this
1768 makes C++ function names readable. @xref{c++filt}, for more information
1771 @item -e @var{filename}
1772 @itemx --exe=@var{filename}
1773 Specify the name of the executable for which addresses should be
1774 translated. The default file is @file{a.out}.
1778 Display function names as well as file and line number information.
1782 Display only the base of each file name.
1788 @code{nlmconv} converts a relocatable object file into a NetWare
1792 @code{nlmconv} currently works with @samp{i386} object
1793 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1794 object files in @sc{elf}, or @code{a.out} format@footnote{
1795 @code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1796 format in the Binary File Descriptor library. It has only been tested
1797 with the above formats.}.
1801 @emph{Warning:} @code{nlmconv} is not always built as part of the binary
1802 utilities, since it is only useful for NLM targets.
1806 nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1807 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
1808 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
1809 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
1810 [ -h | --help ] [ -V | --version ]
1811 @var{infile} @var{outfile}
1814 @code{nlmconv} converts the relocatable @samp{i386} object file
1815 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1816 reading @var{headerfile} for NLM header information. For instructions
1817 on writing the NLM command file language used in header files, see the
1818 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1819 Development and Tools Overview}, which is part of the NLM Software
1820 Developer's Kit (``NLM SDK''), available from Novell, Inc.
1821 @code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
1822 @var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
1825 @code{nlmconv} can perform a link step. In other words, you can list
1826 more than one object file for input if you list them in the definitions
1827 file (rather than simply specifying one input file on the command line).
1828 In this case, @code{nlmconv} calls the linker for you.
1831 @item -I @var{bfdname}
1832 @itemx --input-target=@var{bfdname}
1833 Object format of the input file. @code{nlmconv} can usually determine
1834 the format of a given file (so no default is necessary).
1835 @xref{Target Selection}, for more information.
1837 @item -O @var{bfdname}
1838 @itemx --output-target=@var{bfdname}
1839 Object format of the output file. @code{nlmconv} infers the output
1840 format based on the input format, e.g. for a @samp{i386} input file the
1841 output format is @samp{nlm32-i386}.
1842 @xref{Target Selection}, for more information.
1844 @item -T @var{headerfile}
1845 @itemx --header-file=@var{headerfile}
1846 Reads @var{headerfile} for NLM header information. For instructions on
1847 writing the NLM command file language used in header files, see@ see the
1848 @samp{linkers} section, of the @cite{NLM Development and Tools
1849 Overview}, which is part of the NLM Software Developer's Kit, available
1854 Displays (on standard error) the linker command line used by @code{nlmconv}.
1856 @item -l @var{linker}
1857 @itemx --linker=@var{linker}
1858 Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1863 Prints a usage summary.
1867 Prints the version number for @code{nlmconv}.
1873 @code{windres} may be used to manipulate Windows resources.
1876 @emph{Warning:} @code{windres} is not always built as part of the binary
1877 utilities, since it is only useful for Windows targets.
1881 windres [options] [input-file] [output-file]
1884 @code{windres} reads resources from an input file and copies them into
1885 an output file. Either file may be in one of three formats:
1889 A text format read by the Resource Compiler.
1892 A binary format generated by the Resource Compiler.
1895 A COFF object or executable.
1898 The exact description of these different formats is available in
1899 documentation from Microsoft.
1901 When @code{windres} converts from the @code{rc} format to the @code{res}
1902 format, it is acting like the Windows Resource Compiler. When
1903 @code{windres} converts from the @code{res} format to the @code{coff}
1904 format, it is acting like the Windows @code{CVTRES} program.
1906 When @code{windres} generates an @code{rc} file, the output is similar
1907 but not identical to the format expected for the input. When an input
1908 @code{rc} file refers to an external filename, an output @code{rc} file
1909 will instead include the file contents.
1911 If the input or output format is not specified, @code{windres} will
1912 guess based on the file name, or, for the input file, the file contents.
1913 A file with an extension of @file{.rc} will be treated as an @code{rc}
1914 file, a file with an extension of @file{.res} will be treated as a
1915 @code{res} file, and a file with an extension of @file{.o} or
1916 @file{.exe} will be treated as a @code{coff} file.
1918 If no output file is specified, @code{windres} will print the resources
1919 in @code{rc} format to standard output.
1921 The normal use is for you to write an @code{rc} file, use @code{windres}
1922 to convert it to a COFF object file, and then link the COFF file into
1923 your application. This will make the resources described in the
1924 @code{rc} file available to Windows.
1927 @item -i @var{filename}
1928 @itemx --input @var{filename}
1929 The name of the input file. If this option is not used, then
1930 @code{windres} will use the first non-option argument as the input file
1931 name. If there are no non-option arguments, then @code{windres} will
1932 read from standard input. @code{windres} can not read a COFF file from
1935 @item -o @var{filename}
1936 @itemx --output @var{filename}
1937 The name of the output file. If this option is not used, then
1938 @code{windres} will use the first non-option argument, after any used
1939 for the input file name, as the output file name. If there is no
1940 non-option argument, then @code{windres} will write to standard output.
1941 @code{windres} can not write a COFF file to standard output.
1943 @item -I @var{format}
1944 @itemx --input-format @var{format}
1945 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
1946 @samp{coff}. If no input format is specified, @code{windres} will
1947 guess, as described above.
1949 @item -O @var{format}
1950 @itemx --output-format @var{format}
1951 The output format to generate. @var{format} may be @samp{res},
1952 @samp{rc}, or @samp{coff}. If no output format is specified,
1953 @code{windres} will guess, as described above.
1955 @item -F @var{target}
1956 @itemx --target @var{target}
1957 Specify the BFD format to use for a COFF file as input or output. This
1958 is a BFD target name; you can use the @code{--help} option to see a list
1959 of supported targets. Normally @code{windres} will use the default
1960 format, which is the first one listed by the @code{--help} option.
1961 @ref{Target Selection}.
1963 @item --preprocessor @var{program}
1964 When @code{windres} reads an @code{rc} file, it runs it through the C
1965 preprocessor first. This option may be used to specify the preprocessor
1966 to use, including any leading arguments. The default preprocessor
1967 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
1969 @item --include-dir @var{directory}
1970 Specify an include directory to use when reading an @code{rc} file.
1971 @code{windres} will pass this to the preprocessor as an @code{-I}
1972 option. @code{windres} will also search this directory when looking for
1973 files named in the @code{rc} file.
1975 @item --define @var{sym[=val]}
1976 Specify a @code{-D} option to pass to the preprocessor when reading an
1979 @item --language @var{val}
1980 Specify the default language to use when reading an @code{rc} file.
1981 @var{val} should be a hexadecimal language code. The low eight bits are
1982 the language, and the high eight bits are the sublanguage.
1985 Prints a usage summary.
1988 Prints the version number for @code{windres}.
1991 If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1},
1992 this will turn on parser debugging.
1995 @node Selecting The Target System
1996 @chapter Selecting the target system
1998 You can specify three aspects of the target system to the @sc{gnu}
1999 binary file utilities, each in several ways:
2009 the linker emulation (which applies to the linker only)
2012 In the following summaries, the lists of ways to specify values are in
2013 order of decreasing precedence. The ways listed first override those
2016 The commands to list valid values only list the values for which the
2017 programs you are running were configured. If they were configured with
2018 @samp{--enable-targets=all}, the commands list most of the available
2019 values, but a few are left out; not all targets can be configured in at
2020 once because some of them can only be configured @dfn{native} (on hosts
2021 with the same type as the target system).
2024 * Target Selection::
2025 * Architecture Selection::
2026 * Linker Emulation Selection::
2029 @node Target Selection
2030 @section Target Selection
2032 A @dfn{target} is an object file format. A given target may be
2033 supported for multiple architectures (@pxref{Architecture Selection}).
2034 A target selection may also have variations for different operating
2035 systems or architectures.
2037 The command to list valid target values is @samp{objdump -i}
2038 (the first column of output contains the relevant information).
2040 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
2041 @samp{a.out-sunos-big}.
2043 You can also specify a target using a configuration triplet. This is
2044 the same sort of name that is passed to configure to specify a target.
2045 When you use a configuration triplet as an argument, it must be fully
2046 canonicalized. You can see the canonical version of a triplet by
2047 running the shell script @file{config.sub} which is included with the
2050 Some sample configuration triplets are: @samp{m68k-hp-bsd},
2051 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
2053 @subheading @code{objdump} Target
2059 command line option: @samp{-b} or @samp{--target}
2062 environment variable @code{GNUTARGET}
2065 deduced from the input file
2068 @subheading @code{objcopy} and @code{strip} Input Target
2074 command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
2077 environment variable @code{GNUTARGET}
2080 deduced from the input file
2083 @subheading @code{objcopy} and @code{strip} Output Target
2089 command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
2092 the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
2095 environment variable @code{GNUTARGET}
2098 deduced from the input file
2101 @subheading @code{nm}, @code{size}, and @code{strings} Target
2107 command line option: @samp{--target}
2110 environment variable @code{GNUTARGET}
2113 deduced from the input file
2116 @subheading Linker Input Target
2122 command line option: @samp{-b} or @samp{--format}
2123 (@pxref{Options,,Options,ld.info,Using LD})
2126 script command @code{TARGET}
2127 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2130 environment variable @code{GNUTARGET}
2131 (@pxref{Environment,,Environment,ld.info,Using LD})
2134 the default target of the selected linker emulation
2135 (@pxref{Linker Emulation Selection})
2138 @subheading Linker Output Target
2144 command line option: @samp{-oformat}
2145 (@pxref{Options,,Options,ld.info,Using LD})
2148 script command @code{OUTPUT_FORMAT}
2149 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2152 the linker input target (see ``Linker Input Target'' above)
2155 @node Architecture Selection
2156 @section Architecture selection
2158 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
2159 to run. Its name may contain a colon, separating the name of the
2160 processor family from the name of the particular @sc{cpu}.
2162 The command to list valid architecture values is @samp{objdump -i} (the
2163 second column contains the relevant information).
2165 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
2167 @subheading @code{objdump} Architecture
2173 command line option: @samp{-m} or @samp{--architecture}
2176 deduced from the input file
2179 @subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
2185 deduced from the input file
2188 @subheading Linker Input Architecture
2194 deduced from the input file
2197 @subheading Linker Output Architecture
2203 script command @code{OUTPUT_ARCH}
2204 (@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2207 the default architecture from the linker output target
2208 (@pxref{Target Selection})
2211 @node Linker Emulation Selection
2212 @section Linker emulation selection
2214 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
2215 the linker default values for the other aspects of the target system.
2216 In particular, it consists of
2226 several ``hook'' functions that are run at certain stages of the linking
2227 process to do special things that some targets require
2230 The command to list valid linker emulation values is @samp{ld -V}.
2232 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
2238 command line option: @samp{-m}
2239 (@pxref{Options,,Options,ld.info,Using LD})
2242 environment variable @code{LDEMULATION}
2245 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
2246 which comes from @code{EMUL} in @file{config/@var{target}.mt}
2249 @node Reporting Bugs
2250 @chapter Reporting Bugs
2252 @cindex reporting bugs
2254 Your bug reports play an essential role in making the binary utilities
2257 Reporting a bug may help you by bringing a solution to your problem, or
2258 it may not. But in any case the principal function of a bug report is
2259 to help the entire community by making the next version of the binary
2260 utilities work better. Bug reports are your contribution to their
2263 In order for a bug report to serve its purpose, you must include the
2264 information that enables us to fix the bug.
2267 * Bug Criteria:: Have you found a bug?
2268 * Bug Reporting:: How to report bugs
2272 @section Have you found a bug?
2273 @cindex bug criteria
2275 If you are not sure whether you have found a bug, here are some guidelines:
2278 @cindex fatal signal
2281 If a binary utility gets a fatal signal, for any input whatever, that is
2282 a bug. Reliable utilities never crash.
2284 @cindex error on valid input
2286 If a binary utility produces an error message for valid input, that is a
2290 If you are an experienced user of binary utilities, your suggestions for
2291 improvement are welcome in any case.
2295 @section How to report bugs
2297 @cindex bugs, reporting
2299 A number of companies and individuals offer support for @sc{gnu}
2300 products. If you obtained the binary utilities from a support
2301 organization, we recommend you contact that organization first.
2303 You can find contact information for many support companies and
2304 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
2307 In any event, we also recommend that you send bug reports for the binary
2308 utilities to @samp{bug-gnu-utils@@prep.ai.mit.edu}.
2310 The fundamental principle of reporting bugs usefully is this:
2311 @strong{report all the facts}. If you are not sure whether to state a
2312 fact or leave it out, state it!
2314 Often people omit facts because they think they know what causes the
2315 problem and assume that some details do not matter. Thus, you might
2316 assume that the name of a file you use in an example does not matter.
2317 Well, probably it does not, but one cannot be sure. Perhaps the bug is
2318 a stray memory reference which happens to fetch from the location where
2319 that pathname is stored in memory; perhaps, if the pathname were
2320 different, the contents of that location would fool the utility into
2321 doing the right thing despite the bug. Play it safe and give a
2322 specific, complete example. That is the easiest thing for you to do,
2323 and the most helpful.
2325 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
2326 it is new to us. Therefore, always write your bug reports on the assumption
2327 that the bug has not been reported previously.
2329 Sometimes people give a few sketchy facts and ask, ``Does this ring a
2330 bell?'' Those bug reports are useless, and we urge everyone to
2331 @emph{refuse to respond to them} except to chide the sender to report
2334 To enable us to fix the bug, you should include all these things:
2338 The version of the utility. Each utility announces it if you start it
2339 with the @samp{--version} argument.
2341 Without this, we will not know whether there is any point in looking for
2342 the bug in the current version of the binary utilities.
2345 Any patches you may have applied to the source, including any patches
2346 made to the @code{BFD} library.
2349 The type of machine you are using, and the operating system name and
2353 What compiler (and its version) was used to compile the utilities---e.g.
2357 The command arguments you gave the utility to observe the bug. To
2358 guarantee you will not omit something important, list them all. A copy
2359 of the Makefile (or the output from make) is sufficient.
2361 If we were to try to guess the arguments, we would probably guess wrong
2362 and then we might not encounter the bug.
2365 A complete input file, or set of input files, that will reproduce the
2366 bug. If the utility is reading an object file or files, then it is
2367 generally most helpful to send the actual object files, uuencoded if
2368 necessary to get them through the mail system. Making them available
2369 for anonymous FTP is not as good, but may be the only reasonable choice
2370 for large object files.
2372 If the source files were produced exclusively using @sc{gnu} programs
2373 (e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it
2374 may be OK to send the source files rather than the object files. In
2375 this case, be sure to say exactly what version of @code{gcc}, or
2376 whatever, was used to produce the object files. Also say how
2377 @code{gcc}, or whatever, was configured.
2380 A description of what behavior you observe that you believe is
2381 incorrect. For example, ``It gets a fatal signal.''
2383 Of course, if the bug is that the utility gets a fatal signal, then we
2384 will certainly notice it. But if the bug is incorrect output, we might
2385 not notice unless it is glaringly wrong. You might as well not give us
2386 a chance to make a mistake.
2388 Even if the problem you experience is a fatal signal, you should still
2389 say so explicitly. Suppose something strange is going on, such as, your
2390 copy of the utility is out of synch, or you have encountered a bug in
2391 the C library on your system. (This has happened!) Your copy might
2392 crash and ours would not. If you told us to expect a crash, then when
2393 ours fails to crash, we would know that the bug was not happening for
2394 us. If you had not told us to expect a crash, then we would not be able
2395 to draw any conclusion from our observations.
2398 If you wish to suggest changes to the source, send us context diffs, as
2399 generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
2400 option. Always send diffs from the old file to the new file. If you
2401 even discuss something in the @code{ld} source, refer to it by context,
2404 The line numbers in our development sources will not match those in your
2405 sources. Your line numbers would convey no useful information to us.
2408 Here are some things that are not necessary:
2412 A description of the envelope of the bug.
2414 Often people who encounter a bug spend a lot of time investigating
2415 which changes to the input file will make the bug go away and which
2416 changes will not affect it.
2418 This is often time consuming and not very useful, because the way we
2419 will find the bug is by running a single example under the debugger
2420 with breakpoints, not by pure deduction from a series of examples.
2421 We recommend that you save your time for something else.
2423 Of course, if you can find a simpler example to report @emph{instead}
2424 of the original one, that is a convenience for us. Errors in the
2425 output will be easier to spot, running under the debugger will take
2426 less time, and so on.
2428 However, simplification is not vital; if you do not want to do this,
2429 report the bug anyway and send us the entire test case you used.
2432 A patch for the bug.
2434 A patch for the bug does help us if it is a good one. But do not omit
2435 the necessary information, such as the test case, on the assumption that
2436 a patch is all we need. We might see problems with your patch and decide
2437 to fix the problem another way, or we might not understand it at all.
2439 Sometimes with programs as complicated as the binary utilities it is
2440 very hard to construct an example that will make the program follow a
2441 certain path through the code. If you do not send us the example, we
2442 will not be able to construct one, so we will not be able to verify that
2445 And if we cannot understand what bug you are trying to fix, or why your
2446 patch should be an improvement, we will not install it. A test case will
2447 help us to understand.
2450 A guess about what the bug is or what it depends on.
2452 Such guesses are usually wrong. Even we cannot guess right about such
2453 things without first using the debugger to find the facts.